defaultConfig

userProfileStringnull Location on Firebase where user
profiles are stored. Often set to 'users'.

profileFactoryFunctionnull Function for changing how profile is written
to database (both RTDB and Firestore).

presence(String | Function)null Location on Firebase where of currently
online users is stored. Often set to 'presence' or 'onlineUsers'. If a function
is passed, the arguments are: (currentUser, firebase).

sessions(String | Function)sessions Location on Firebase where user
sessions are stored (only if presense is set). Often set to 'sessions' or
'userSessions'. If a function is passed, the arguments are: (currentUser, firebase).

enableLoggingBooleanfalse Whether or not firebase
database logging is enabled. Providing true turns on error logging
(enabled by itself through logErrors).

logErrorsBooleantrue Whether or not to log internal
Firebase errors (i.e. error querying or writing data) to the javascript
console .

preserveOnLogout(Array | Object)null Data parameters to
preserve when logging out. If Array is passed, each item represents keys
within state.firebase.data preserve. If an object is passed, Keys associate
with parts of state to preserve, and the values are Arrays contain keys
for keys within that slice of state to preserve.

preserveOnEmptyAuthChangeObjectnull Data parameters to
preserve when empty auth changes occur. Keys associate with parts of state
to preserve, and the values are either Arrays or Functions. If passing an
array of keys (i.e. { auth: ['key1', 'key2'] }) - those keys ('key1' and
'key2') are preserved from that slice of state (auth). If passing a
function (i.e. { auth: (currentAuthState, nextAuthState) => ({}) }),
whatever is returned from the function is set to that slice of state (auth).

updateProfileOnLoginBooleantrue Whether or not to update
user profile when logging in.

resetBeforeLoginBooleantrue Whether or not to reset auth
and profile when logging in (see issue
#254
for more details).

enableRedirectHandlingBooleantrue Whether or not to enable
redirect handling. This must be disabled if environment is not http/https
such as with react-native.

onAuthStateChangedFunctionnull Function that runs when
auth state changes.

enableEmptyAuthChangesBooleanfalse Whether or not to enable
empty auth changes. When set to true, onAuthStateChanged will be fired with,
empty auth changes such as undefined on initialization
(see #137).
Requires v1.5.0-alpha or higher.

autoPopulateProfileBooleanfalse REMOVED FROM v2.0.0.
Whether or not to automatically populate profile with data loaded through
profileParamsToPopulate config.

setProfilePopulateResultsBooleantrue Whether or not to
call SET actions for data that results from populating profile to redux under
the data path. For example role parameter on profile populated from 'roles'
root. True will call SET_PROFILE as well as a SET action with the role that
is loaded (places it in data/roles).

dispatchOnUnsetListenerBooleantrue Whether or not to
dispatch UNSET_LISTENER when disabling listeners for a specific path. USE WITH CAUTION
Setting this to true allows an action to be called that removes data
from redux (which might not always be expected).

dispatchRemoveActionBooleanfalse Whether or not to
dispatch REMOVE action when calling remove. NOTE Causes two state
updates if a listener is affected by your remove call.

firebaseStateNameString 'firebase' Assumed name of Firebase
state (name given when passing reducer to combineReducers). Used in
firebaseAuthIsReady promise (see
#264).

attachAuthIsReadyBooleanfalse Whether or not to attach
firebaseAuthIsReady to store. authIsLoaded can be imported and used
directly instead based on preference.

firestoreNamespaceBooleanfirestoreHelpers Namespace for
firestore helpers (WARNING Changing this will break firestoreConnect HOC.
Do NOT change to 'firestore')

keysToRemoveFromAuthArray (default at end)
list of keys to remove from authentication reponse before writing to profile
(currenlty only used for profiles stored on Firestore). ['appName', 'apiKey'
, 'authDomain', 'redirectEventId', 'stsTokenManager', 'uid']