Skip to content

Latest commit

 

History

History
211 lines (167 loc) · 6.03 KB

API.md

File metadata and controls

211 lines (167 loc) · 6.03 KB
Raw

API

firebaseStateReducer

The reducer for the firebase data. The reducer keeps data in Immutable.Map format

firebase in store structure

{
  auth: undefined, null or Object, // undefined mean still wating for firebase feedback, null user is not authenticated, if  Object mean user is authenticated and it is the object returned by firebase
  data: immutable,  // corresponded structure from firebase
  authError: Object or String // the error when login or createUser if there is any
}

in firebase store objects can have this values

  • undefined data is not loaded yet
  • null data was loaded but there is nothing in firebase ( when listening for value )
  • {} data was loaded but there is nothing in firebase ( when listening for array )
  • String or Object data loaded

there are helpers for dealing with data ( see helpers )

reduxReactFirebase(FIREBASE_URL, options)

Add firebase to redux

Arguments

  • FIREBASE_URL Firebase URL to connect to
  • options Object with the options

Options

  1. Auto load user profile when authenticate
{
  userProfile: String // path where user profiles are stored
}

if userProfile is specified then onAuth will listen for values in ${userProfile}/${auth.id} and wil be stored into store.state.firebase.profile

userProfile is required if auto creation of a profile in createUser is needed

firebase(arrayOfPathsToListen)

Arguments

  • arrayOfPathToListen(props) (Array or Function) A function that takes the original props passed to the object and returns an array of path to listen. Function is invoked when component mounted and each time new props arrive so it is possible to dynamically change observed paths based on latest props.

Returns

A function that takes the component and wraps it, add firebase object into props and start the needed listeners for respective paths. when a firebase event is happening the value is automatically set into firebase store into firebase.data.[...path]

Examples

listen for value on path ref.on('value', 'todos')

@firebase([
  'todos'
])

listen for multiple paths ref.on('value', 'todos') and ref.on('value', 'users')

@firebase([
  'todos',
  'users'
])

listen for a firebase array ref.on('child_added', 'todos'), ref.on('child_removed', 'todos'), ref.on('child_changed', 'todos')

@firebase([
  ['todos']
])

nesting with connect from redux

@firebase(
  props => ([
    `todos/${props.id}`
  ])
)
@connect(
  (state, props) => ({
    todo: dataToJs(state.firebase, `todos/${props.id}`)
  })
)

nesting with connect from redux and do a firebase query that depend on data from redux store

@connect(
  state => ({
    currentTodo: state.myStore.currentTodo,
    todo: dataToJs(state.firebase, `todos/${state.myStore.currentTodo}`)
  })
)
@firebase(
  props => ([
    `todos/${props.currentTodo}`
  ])
)

queries support

  • orderByChild
  • orderByKey
  • orderByValue
  • orderByPriority
  • limitToFirst
  • limitToLast
  • startAt
  • endAt
  • equalTo
@firebase([
  'todos#startAt=5&limitToFirst=2'
])

or

@firebase([
  'todos#orderByChild=added&startAt=5&limitToFirst=2'
])

just access firebase object in component ( for access to ref or other firebase helpers ) firebase object will be added to props - see firebase object docs

@firebase()

Firebase object

ref

The original Firebase object

set(path, value, onComplete)

Short for ref.child(path).set(value, onComplete)

push(path, value, onComplete)

Short for ref.child(path).push(value, onComplete)

remove(path, onComplete)

Short for ref.child(path).remove(onComplete)

createUser(credentials, profile)

Short for ref.createUser(credentials) but support auto profile and set the errors in authError

resetPassword(credentials)

Short for ref.resetPassword(credentials) and set the output in authError

changePassword(credentials)

Short for ref.changePassword(credentials) and set the output in authError

Arguments

  • credentials same as firebase docs
  • profile if initialized with userProfile support then profile will be saved into ${userProfile}/${auth.uid}

Return

Return a promise with userId in case of success or the error otherwise. Always authenticate the new user in case of success

login(credentials)

Arguments

  • credentials (String or Object)
    • If String then firebase.auth().signInWithCustomToken is used.
    • If object then:
      • firebase.auth().signInWithEmailAndPassword if object has the following shape: 
        {
  email: String
  password: String
}

Return

Return a promise with authData in case of success or the error otherwise.

logout(preserve = [], remove = [])

Logout from Firebase and delete data from the store (store.state.firebase.data) except for paths defined in the preserve array argument. If you want to delete some parts of the preserved subtrees, you can specify the paths in the remove argument. Both of these arguments are optional and are empty arrays by default. If you do not specify them, all the data is deleted.

store.state.firebase.auth is set to null

Data helpers

isLoaded(objects...)

Check if all the objects passed to function are loaded ( not undefined )

  • null mean we have feedback from firebase but there is no data
  • undefined mean still waiting from Firebase

Return

true or false

isEmpty(object)

Check if an object is empty (null if value was requested or empty object {} if array was requested)

Return

true or false

toJS(immutableData)

Short for immutableData.toJS() but take care if immutableData is null or undefined

pathToJS(immutableData, pathAsString, notSetValut)

Short for immutableData.getIn(pathAsString.split(/\//), notSetValue).toJS() but take care if immutableData is null or undefined

dataToJS(immutableData, pathAsString, notSetValue)

Short for pathToJS(immutableData, `data/${pathAsString}`, notSetValue)