Typescript definition

[Keats]

Just an issue to remind me to start doing it as soon as #195 is merged.

Normally that would live in https://github.com/borisyankov/DefinitelyTyped but it doesn't support typescript 1.5 yet so I'll put it here if that's ok, it's also a good way to quickly see the public api of a library imo

[gaearon]

Would #254 help here, or is “definition” a separate thing?

[chicoxyzzy]

TS definition files are different from Flow definition files and AFAIK they aren't compatible with each other

[Keats]

They are a bit different.
I got the following for now that I'm editing/changing as I'm using it

declare module "redux" {
    interface ActionCreator {
        (...args: Array<any>): Object;
    }

    interface ActionCreators {
        [key: string]: ActionCreator
    }

    interface Reducer {
        (state: any, action: Object): any;
    }

    interface StoreMethods {
        dispatch(action: Object): Object;
        getState(): Object;
    }

    class Store {
        getReducer(): Function;
        replaceReducer(nextReducer: Reducer): void;
        dispatch(action: Object): Object;
        getState(): Object;
        subscribe(listener: Function): Function;
    }

    function createStore(
        reducer: Reducer | Object,
        initialState?: any
    ): Store;

    function bindActionCreators<T>(
        actionCreators: ActionCreator | ActionCreators,
        dispatch: Function
    ): T;

    function composeMiddleware(...middlewares: Array<Function>): Function;
    function composeReducers(reducers: Array<Reducer>): Reducer;

}

declare module "redux/react" {
    import React = require("react");
    import redux = require("redux");

    interface ProviderProps {
        store: redux.Store;
        children: Function;
    }

    interface ProviderState {
        store: redux.Store;
    }

    class Provider extends React.Component<ProviderProps, ProviderState> {}

    interface ConnectorProps {
        children: Function;
        select: Function;
    }

    class Connector extends React.Component<ConnectorProps, any> {}
}

It's missing some stuff stilll but it's getting there

[Keats]

Updated a bit (and will likely wait for redux/react-redux to hit 1.0):

declare module "redux" {
    interface ActionCreator {
        (...args: Array<any>): Object;
    }

    interface ActionCreators {
        [key: string]: ActionCreator
    }

    interface Reducer {
        (state: any, action: Object): any;
    }

    interface StoreMethods {
        dispatch(action: Object): Object;
        getState(): Object;
    }

    class Store {
        getReducer(): Function;
        replaceReducer(nextReducer: Reducer): void;
        dispatch(action: Object): Object;
        getState(): Object;
        subscribe(listener: Function): Function;
    }

    function createStore(
        reducer: Reducer | Object,
        initialState?: any
    ): Store;

    function bindActionCreators<T>(
        actionCreators: ActionCreator | ActionCreators,
        dispatch: Function
    ): T;

    function composeMiddleware(...middlewares: Array<Function>): Function;
    function combineReducers(reducers: Object): Reducer;

}

declare module "react-redux" {
    import React = require("react");
    import redux = require("redux");

    interface ProviderProps {
        store: redux.Store;
        children: Function;
    }

    interface ProviderState {
        store: redux.Store;
    }

    class Provider extends React.Component<ProviderProps, ProviderState> {}

    interface ConnectorProps {
        children: Function;
        select: Function;
    }

    class Connector extends React.Component<ConnectorProps, any> {}
}

[wbuchwalter]

Nice job!
Some thoughts:

• It would be nice to have redux and react-redux distributed separately for those using redux without react.
• Is there a particular reason you are using Object instead of any?
  For example having Store.getState() returning any instead of Object would allow to do Store.getState().todoReducer without compile time error.

[gaearon]

It would be nice to have redux and react-redux distributed separately for those using redux without react.

That's how it is in 1.0 RC (and will be in 1.0). The React bindings are split into http://github.com/gaearon/react-redux.

[Keats]

It should return any indeed
That's still a WIP at this point so i will separate later on, going to work on a small boilerplate with typescript/redux/immutablejs to make sure it all works fine

[wbuchwalter]

Here is a slightly updated version (without react-redux).
Can still be improved, but If you are ok with this, I'll submit a PR on DefinitlyTyped so others can start using it and give us feedback.

declare module Redux {

  interface ActionCreator extends Function {
    (...args: any[]): any;
  }

  interface ActionCreators {
    [key: string]: ActionCreator
  }

  interface Reducer extends Function {
    (state: any, action: any): any;
  }

  interface Dispatch extends Function {
    (action: any): any;
  }

  interface StoreMethods {
    dispatch: Dispatch;
    getState(): any;
  }

  interface MiddlewareArg {
    dispatch: Dispatch;
    getState: Function;
  }

  interface Middleware extends Function {
    (obj: MiddlewareArg): Function;
  }

  class Store {
    getReducer(): Reducer;
    replaceReducer(nextReducer: Reducer): void;
    dispatch(action: any): any;
    getState(): any;
    subscribe(listener: Function): Function;
  }

  function createStore(reducer: Reducer, initialState?: any): Store;
  function bindActionCreators<T>(actionCreators: ActionCreator | ActionCreators, dispatch: Dispatch): T;
  function composeMiddleware(...middlewares: any[]): Function;
  function combineReducers(reducers: any): Reducer;
  function applyMiddleware(...middleware: Middleware[]): Function;
}

declare module "redux" {
  export = Redux;
};

[gaearon]

@wbuchwalter This looks good to me! One minor change is I don't think bindActionCreators accepts a single action creator. Another change is we're removing composeMiddleware from public API (it was added by accident and there are no use cases for it).

It also would be nice to describe reducer in combineReducers as { [key]: string: Reducer }.

[Keats]

Looks good !
I believe StoreMethods is not needed and isn't MiddlewareArg only that if you use redux-thunk?

I would wait until 1.0 to submit it on definitelytyped.
In the meantime I started a boilerplate/example in typescript that I'm using to test things out: https://github.com/Keats/react-boilerplate
Not finished yet but would be nice to have feedback, I find it a bit annoying to have to dispatch 2 actions when I add one card for example

[gaearon]

@Keats MiddlewareArg is not for redux-thunk, it's actually for implementing middleware itself. This is the “thing” middleware receives. redux-thunk just happens to pass it down.

[Keats]

Yes indeed, I realised after posting, as always. Cheers

[wbuchwalter]

Updated following your suggestions:

declare module Redux {

  interface ActionCreator extends Function {
    (...args: any[]): any;
  }

  interface ActionCreators {
    [key: string]: ActionCreator;
  }

  interface Reducer extends Function {
    (state: any, action: any): any;
  }

  interface Reducers {
    [key: string]: Reducer;
  }

  interface Dispatch extends Function {
    (action: any): any;
  }

  interface StoreMethods {
    dispatch: Dispatch;
    getState(): any;
  }

  interface MiddlewareArg {
    dispatch: Dispatch;
    getState: Function;
  }

  interface Middleware extends Function {
    (obj: MiddlewareArg): Function;
  }

  class Store {
    getReducer(): Reducer;
    replaceReducer(nextReducer: Reducer): void;
    dispatch(action: any): any;
    getState(): any;
    subscribe(listener: Function): Function;
  }

  function createStore(reducer: Reducer, initialState?: any): Store;
  function bindActionCreators<T>(actionCreators: ActionCreators, dispatch: Dispatch): T;
  function combineReducers(reducers: Reducers): Reducer;
  function applyMiddleware(...middleware: Middleware[]): Function;
}

declare module "redux" {
  export = Redux;
}

@Keats Regarding DefinitlyTyped, we can add a README and a prefix to make it clear this is targeting 1.0 if that is your concern.
Several people already asked me about that, and it would be easier to follow progress.
Let me know what you think.

[gaearon]

Minor change: I just merged a PR that also lets bindActionCreators to accept a single function instead of object (and return a function in this case). The rest looks good to me.