Logo for jsDocs.io

@types/react-router-redux

  • Version 5.0.27
  • Published
  • 7.21 kB
  • 4 dependencies
  • MIT license

Install

npm i @types/react-router-redux
yarn add @types/react-router-redux
pnpm add @types/react-router-redux

Overview

TypeScript definitions for react-router-redux

Index

Variables

Functions

Classes

Interfaces

Variables

variable CALL_HISTORY_METHOD

const CALL_HISTORY_METHOD: string;

    variable LOCATION_CHANGE

    const LOCATION_CHANGE: string;

      variable routerActions

      const routerActions: {
          push: typeof push;
          replace: typeof replace;
          go: typeof go;
          goBack: typeof goBack;
          goForward: typeof goForward;
      };

        variable routerReducer

        const routerReducer: Reducer<RouterState, Action>;

          Functions

          function createMatchSelector

          createMatchSelector: (
              path: string
          ) => (state: { router: RouterState }) => match | null;

            function go

            go: (n: number) => RouterAction;

              function goBack

              goBack: () => RouterAction;

                function goForward

                goForward: () => RouterAction;

                  function push

                  push: (location: LocationDescriptor, state?: LocationState) => RouterAction;

                    function replace

                    replace: (location: LocationDescriptor, state?: LocationState) => RouterAction;

                      function routerMiddleware

                      routerMiddleware: (history: History) => Middleware;

                        Classes

                        class ConnectedRouter

                        class ConnectedRouter<State> extends React.Component<ConnectedRouterProps<State>> {}

                          Interfaces

                          interface ConnectedRouterProps

                          interface ConnectedRouterProps<State> {}

                            property children

                            children?: React.ReactNode;

                              property history

                              history: History;

                                property store

                                store?: Store<State> | undefined;

                                  interface LocationActionPayload

                                  interface LocationActionPayload {}

                                    property args

                                    args?: any[] | undefined;

                                      property method

                                      method: string;

                                        interface LocationChangeAction

                                        interface LocationChangeAction {}

                                          property payload

                                          payload: Location & {
                                              props?:
                                                  | {
                                                        match: {
                                                            path: string;
                                                            url: string;
                                                            params: any;
                                                            isExact: boolean;
                                                        };
                                                        location: Location;
                                                        history: History;
                                                    }
                                                  | undefined;
                                          };

                                            property type

                                            type: typeof LOCATION_CHANGE;

                                              interface RouterAction

                                              interface RouterAction {}

                                                property payload

                                                payload: LocationActionPayload;

                                                  property type

                                                  type: typeof CALL_HISTORY_METHOD;

                                                    interface RouterState

                                                    interface RouterState {}

                                                      property location

                                                      location: Location | null;

                                                        Package Files (1)

                                                        Dependencies (4)

                                                        Dev Dependencies (0)

                                                        No dev dependencies.

                                                        Peer Dependencies (0)

                                                        No peer dependencies.

                                                        Badge

                                                        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/react-router-redux.

                                                        • Markdown
                                                          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/react-router-redux)
                                                        • HTML
                                                          <a href="https://www.jsdocs.io/package/@types/react-router-redux"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>