Database

database.read(pathOrRef)

Generator

Returns the data at this path in firebase's database.

Arguments

Output

Whatever value is store at this path in the database (number, string, object, etc).

Example

function* getTodo() {
  const firstTodo = yield call(rsf.database.read, 'todos/1');
  yield put(gotTodo(firstTodo));
}

database.create(pathOrRef, data)

Generator

Create a new path in the database and stores the data there.

Arguments

Output

The key newly created (a string).

Example

function* addTodo() {
  const key = yield call(rsf.database.create, 'todos', {
    done: false,
    label: 'Do this',
  });
  // `key` is something like "-Kfn7EyLEoHax0YGoQr0"
}

database.update(pathOrRef, data)

Generator

Replace the value store at path in the database with data.

Arguments

Example

function* updateTodo() {
  yield call(rsf.database.update, 'todos/-Kfn7EyLEoHax0YGoQr0', {
    done: true, // yay, it's done now!
    label: 'Do this',
  });
}

database.patch(pathOrRef, data)

Generator

Patches the value store at path in the database with data. Like database.update but doesn't remove unmentionned keys.

Arguments

Example

function* updateTodo() {
  // With this call, no need to re-send the todo label.
  yield call(rsf.database.patch, 'todos/-Kfn7EyLEoHax0YGoQr0', {
    done: true,
  });
}

database.delete(pathOrRef)

Generator

Removes the value at the specified path in the database.

Arguments

Example

function* deleteTodo() {
  yield call(rsf.database.delete, 'todos/-Kfn7EyLEoHax0YGoQr0');
}

database.channel(pathOrRef, event, buffer)

Function

Returns a redux-saga Channel which emits every change at the specified path in the database.

Arguments

Output

A redux-saga Channel which emits every change at the specified path in the database. The emitted value is an object with two keys:

• snapshot: a firebase.database.DataSnapshot ;
• value: the result of snapshot.val(), which is the actual value stored in the database (any type).

Example

function* syncTodosSaga() {
  const channel = yield call(rsf.database.channel, 'todos');

  while(true) {
    const { value: todos } = yield take(channel);
    yield put(syncTodos(todos));
  }
}

database.sync(pathOrRef, options, event)

Generator

Automatically dispatches a redux action every time path changes.

Arguments

Example

import { syncTodos } from '../actionCreators/todos';

function* todoRootSaga() {
  yield fork(
    rsf.database.sync,
    'todos',
    { successActionCreator: syncTodos }
  );
}