Skip to content

Latest commit

 

History

History
105 lines (88 loc) · 8.95 KB

constants.md

File metadata and controls

105 lines (88 loc) · 8.95 KB

Table of Contents

actionsPrefix

Prefix for all actions within library

Type: string

Examples

import { constants } from 'react-redux-firebase'
constants.actionsPrefix === '@@reactReduxFirebase' // true

actionTypes

Object containing all action types

Properties

  • START String @@reactReduxFirebase/START
  • SET String @@reactReduxFirebase/SET
  • SET_PROFILE String @@reactReduxFirebase/SET_PROFILE
  • LOGIN String @@reactReduxFirebase/LOGIN
  • LOGOUT String @@reactReduxFirebase/LOGOUT
  • LOGIN_ERROR String @@reactReduxFirebase/LOGIN_ERROR
  • NO_VALUE String @@reactReduxFirebase/NO_VALUE
  • UNAUTHORIZED_ERROR String @@reactReduxFirebase/UNAUTHORIZED_ERROR
  • SET_LISTENER String @@reactReduxFirebase/SET_LISTENER
  • UNSET_LISTENER String @@reactReduxFirebase/UNSET_LISTENER
  • AUTHENTICATION_INIT_STARTED String @@reactReduxFirebase/AUTHENTICATION_INIT_STARTED
  • AUTHENTICATION_INIT_FINISHED String @@reactReduxFirebase/AUTHENTICATION_INIT_FINISHED
  • SESSION_START String @@reactReduxFirebase/SESSION_START
  • SESSION_END String @@reactReduxFirebase/SESSION_END
  • FILE_UPLOAD_START String @@reactReduxFirebase/FILE_UPLOAD_START
  • FILE_UPLOAD_ERROR String @@reactReduxFirebase/FILE_UPLOAD_ERROR
  • FILE_UPLOAD_PROGRESS String @@reactReduxFirebase/FILE_UPLOAD_PROGRESS
  • FILE_UPLOAD_COMPLETE String @@reactReduxFirebase/FILE_UPLOAD_COMPLETE
  • FILE_DELETE_START String @@reactReduxFirebase/FILE_DELETE_START
  • FILE_DELETE_ERROR String @@reactReduxFirebase/FILE_DELETE_ERROR
  • FILE_DELETE_COMPLETE String @@reactReduxFirebase/FILE_DELETE_COMPLETE
  • AUTH_UPDATE_START String @@reactReduxFirebase/AUTH_UPDATE_START
  • AUTH_UPDATE_ERROR String @@reactReduxFirebase/AUTH_UPDATE_ERROR
  • AUTH_UPDATE_COMPLETE String @@reactReduxFirebase/AUTH_UPDATE_COMPLETE
  • PROFILE_UPDATE_START String @@reactReduxFirebase/PROFILE_UPDATE_START
  • PROFILE_UPDATE_ERROR String @@reactReduxFirebase/PROFILE_UPDATE_ERROR
  • PROFILE_UPDATE_COMPLETE String @@reactReduxFirebase/PROFILE_UPDATE_COMPLETE
  • EMAIL_UPDATE_START String @@reactReduxFirebase/EMAIL_UPDATE_START
  • EMAIL_UPDATE_ERROR String @@reactReduxFirebase/EMAIL_UPDATE_ERROR
  • EMAIL_UPDATE_COMPLETE String @@reactReduxFirebase/EMAIL_UPDATE_COMPLETE

Examples

import { actionTypes } from 'react-redux-firebase'
actionTypes.SET === '@@reactReduxFirebase/SET' // true

defaultConfig

Default configuration options

Properties

  • userProfile String null Location on Firebase where user profiles are stored. Often set to 'users'.
  • 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).
  • enableLogging Boolean false Whether or not firebase database logging is enabled.
  • preserveOnLougout Array null Data parameters to preserve when logging out.
  • updateProfileOnLogin Boolean true Whether or not to update user profile when logging in.
  • enableRedirectHandling Boolean true Whether or not to enable redirect handling. This must be disabled if environment is not http/https such as with react-native.
  • enableEmptyAuthChanges Boolean false 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.
  • autoPopulateProfile Boolean false REMOVED FROM v2.0.0. Whether or not to automatically populate profile with data loaded through profileParamsToPopulate config.
  • setProfilePopulateResults Boolean true Whether or not to call SET actions for data that results from populating profile to redux under the data path. For example: role paramter 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).
  • dispatchOnUnsetListener Boolean false 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).