Make key optional

Fixes #65

Author: Ashoat

README.md

@@ -89,28 +89,28 @@ class Root extends React.Component {
 
 ```js
 function createReactNavigationReduxMiddleware<State: {}>(
-  key: string,
   navStateSelector: (state: State) => NavigationState,
+  key?: string,
 ): Middleware<State, *, *>;
 ```
 
 * Returns a middleware that can be applied to a Redux store.
-* Param `key` needs to be unique for the Redux store. Most people only have one store, so can use any string (eg. `"root"`), as long as it's consistent with the call to `createReduxContainer` below.
 * Param `navStateSelector` selects the navigation state from your store.
+* Param `key` needs to be unique for the Redux store and consistent with the call to `createReduxContainer` below. You can leave it out if you only have one store.
 
 ### `createReduxContainer` (required)
 
 ```js
 function createReduxContainer(
   navigator: Navigator,
-  key: string,
+  key?: string,
 ): React.ComponentType<{ state: NavigationState, dispatch: Dispatch }>;
 ```
 
 * Returns a HOC (higher-order component) that wraps your root navigator.
 * `createReactNavigationReduxMiddleware` must be called before this one!
 * Param `navigator` is your root navigator (React component).
-* Param `key` needs to be consistent with the call to `createReactNavigationReduxMiddleware` above.
+* Param `key` needs to be consistent with the call to `createReactNavigationReduxMiddleware` above. You can leave it out if you only have one store.
 * Returns a component to use in place of your root navigator. Pass it `state` and `dispatch` props that you get via `react-redux`'s `connect`.
 
 ### `createNavigationReducer` (optional)

index.d.ts

@@ -14,13 +14,15 @@ declare module 'react-navigation-redux-helpers' {
 
   export type ReducerState = NavigationState | null | undefined;
 
-  export function createReactNavigationReduxMiddleware<S>
-  (key: string, navStateSelector: (state: S) => NavigationState): Middleware;
+  export function createReactNavigationReduxMiddleware<S>(
+    navStateSelector: (state: S) => NavigationState,
+    key?: string,
+  ): Middleware;
 
   export function createNavigationReducer(navigator: Navigator): Reducer<ReducerState>;
 
   export function createReduxContainer<S, P>(
     navigator: Navigator,
-    key: string,
+    key?: string,
   ): React.ComponentType<{ state: NavigationState; dispatch: NavigationDispatch } & P>;
 }

src/create-redux-container.js

@@ -28,7 +28,7 @@ function createReduxContainer<State: NavigationState, Props: RequiredProps<State
     *,
     $Diff<Props, RequiredProps<State>>,
   >,
-  key: string,
+  key?: string = "root",
 ): React.ComponentType<Props> {
   const didUpdateCallback = createDidUpdateCallback(key);
   const propConstructor = createNavigationPropConstructor(key);

src/middleware.js

@@ -23,8 +23,8 @@ const EMPTY_SCREEN_PROPS = {};
 const getScreenProps = () => EMPTY_SCREEN_PROPS;
 
 function createReactNavigationReduxMiddleware<State: {}>(
-  key: string,
   navStateSelector: (state: State) => NavigationState,
+  key?: string = "root",
 ): Middleware<State, *, *> {
   reduxSubscribers.set(key, new Set());
   return store => next => action => {