API

How to read the API

• Parameter names beginning with ? are optional
• HigherOrderComponent is a function of type:

    ReactClass | ReactFunctionalComponent | string =>
      ReactClass | ReactFunctionalComponent | string
  

Redirection Helpers (React Router 3/History v3)

connectedRouterRedirect

import { connectedRouterRedirect } from 'redux-auth-wrapper/history3/redirect'

connectedRouterRedirect({
  redirectPath: string | (state: Object, ownProps: Object) => string,
  authenticatedSelector: (state: Object, ownProps: Object) => boolean,
  ?authenticatingSelector: (state: Object, ownProps: Object) => boolean,
  ?AuthenticatingComponent: ReactClass | ReactFunctionalComponent | string,
  ?wrapperDisplayName: string,
  ?allowRedirectBack: boolean | (nextState: Object, redirectPath: String) => boolean,
  ?redirectQueryParamName: string
}): HigherOrderComponent

connectedReduxRedirect

import { connectedReduxRedirect } from 'redux-auth-wrapper/history3/redirect'

connectedReduxRedirect({
  redirectPath: string | (state: Object, ownProps: Object) => string,
  authenticatedSelector: (state: Object, ownProps: Object) => boolean,
  ?authenticatingSelector: (state: Object, ownProps: Object) => boolean,
  ?AuthenticatingComponent: ReactClass | ReactFunctionalComponent | string,
  ?wrapperDisplayName: string,
  ?allowRedirectBack: boolean | (nextState: Object, redirectPath: String) => boolean,
  ?redirectQueryParamName: string
}): HigherOrderComponent

createOnEnter

import { createOnEnter } from 'redux-auth-wrapper/history3/redirect'

createOnEnter({
  redirectPath: string | (state: Object, nextState: Object) => string,
  authenticatedSelector: (state: Object, nextState: Object) => boolean,
  ?authenticatingSelector: (state: Object, nextState: Object) => boolean,
  ?AuthenticatingComponent: ReactClass | ReactFunctionalComponent | string,
  ?wrapperDisplayName: string,
  ?allowRedirectBack: boolean | (nextState: Object, redirectPath: String) => boolean,
  ?redirectQueryParamName: string
}): (store: Object, nextState: Object: replace: (location: Object => void))

locationHelperBuilder

Helper used by the redirection and useful for pulling the redirectPath out of the query params.

import locationHelperBuilder from 'redux-auth-wrapper/history3/locationHelper'

locationHelperBuilder({
  ?redirectQueryParamName: string,
  ?locationSelector: (props: Object) => LocationObject
}) : LocationHelper


LocationHelper: {
  getRedirectQueryParam: (props: Object) => string,
  createRedirectLoc: allowRedirectBack: boolean => (nextState: Object, redirectPath: string) => LocationObject,
}

Redirection Helpers (React Router 4/History v4)

connectedRouterRedirect

import { connectedRouterRedirect } from 'redux-auth-wrapper/history4/redirect'

connectedRouterRedirect({
  redirectPath: string | (state: Object, ownProps: Object) => string,
  authenticatedSelector: (state: Object, ownProps: Object) => boolean,
  ?authenticatingSelector: (state: Object, ownProps: Object) => boolean,
  ?AuthenticatingComponent: ReactClass | ReactFunctionalComponent | string,
  ?wrapperDisplayName: string,
  ?allowRedirectBack: boolean | (nextState: Object, redirectPath: String) => boolean,
  ?redirectQueryParamName: string
}): HigherOrderComponent

connectedReduxRedirect

import { connectedReduxRedirect } from 'redux-auth-wrapper/history4/redirect'

connectedReduxRedirect({
  redirectPath: string | (state: Object, ownProps: Object) => string,
  redirectAction: (location: Object) => ReduxAction,
  authenticatedSelector: (state: Object, ownProps: Object) => boolean,
  ?authenticatingSelector: (state: Object, ownProps: Object) => boolean,
  ?AuthenticatingComponent: ReactClass | ReactFunctionalComponent | string,
  ?wrapperDisplayName: string,
  ?allowRedirectBack: boolean | (nextState: Object, redirectPath: String) => boolean,
  ?redirectQueryParamName: string
}): HigherOrderComponent

locationHelperBuilder

import locationHelperBuilder from 'redux-auth-wrapper/history4/locationHelper'

locationHelperBuilder({
  ?redirectQueryParamName: string,
  ?locationSelector: (props: Object) => LocationObject
}) : LocationHelper


LocationHelper: {
  getRedirectQueryParam: (props: Object) => string,
  createRedirectLoc: allowRedirectBack: boolean => (nextState: Object, redirectPath: string) => LocationObject,
}

Other Wrappers

authWrapper

import authWrapper from 'redux-auth-wrapper/authWrapper'

authWrapper({
  ?AuthenticatingComponent: ReactClass | ReactFunctionalComponent | string,
  ?FailureComponent: ReactClass | ReactFunctionalComponent | string,
  ?wrapperDisplayName: string
}): HigherOrderComponent

The returned Component after applying a Component to the HOC takes as props isAuthenticated and isAuthenticating, both of which are booleans. isAuthenticating defaults to false.

connectedAuthWrapper

import connectedAuthWrapper from 'redux-auth-wrapper/connectedAuthWrapper'

connectedAuthWrapper({
  authenticatedSelector: (state: Object, ownProps: Object) => boolean,
  ?authenticatingSelector: (state: Object, ownProps: Object) => boolean,
  ?AuthenticatingComponent: ReactClass | ReactFunctionalComponent | string,
  ?FailureComponent: ReactClass | ReactFunctionalComponent | string,
  ?wrapperDisplayName: string
}): HigherOrderComponent

Other Helpers

Documentation in progress!