Skip to content

Commit 5640aee

Browse files
author
Scott Prue
committed
feat(core): remove consumer exports from top level API (available from Context.Consumer)
fix(core): remove firebaseStateReducer from top level API (redundant) * feat(docs): update migraiton guide with more removed API method changes * fix(helpers): use native filter in place of compact in populate
1 parent db790d3 commit 5640aee

17 files changed

+634
-453
lines changed

SUMMARY.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
* [withFirebase](/docs/api/withFirebase.md)
3737
* [firestoreConnect](/docs/api/firestoreConnect.md)
3838
* [withFirestore](/docs/api/withFirestore.md)
39-
* [firebaseReducer](/docs/api/reducer.md)
39+
* [reducer](/docs/api/reducer.md)
4040
* [isInitializingReducer](/docs/api/reducers.md#isinitializingreducer)
4141
* [requestingReducer](/docs/api/reducers.md#requestingreducer)
4242
* [requestedReducer](/docs/api/reducers.md#requestedreducer)
@@ -48,7 +48,7 @@
4848
* [listenersReducer](/docs/api/reducers.md#listenersreducer)
4949
* [dataReducer](/docs/api/reducers.md#datareducer)
5050
* [orderedReducer](/docs/api/reducers.md#orderedreducer)
51-
* [props.firebase](/docs/api/props-firebase.md)
51+
* [firebaseInstance](/docs/api/firebaseInstance.md)
5252
* [getFirebase](/docs/api/getFirebase.md)
5353
* [ReactReduxFirebaseContext](/docs/api/ReactReduxFirebaseContext.md)
5454
* [ReactReduxFirebaseProvider](/docs/api/ReactReduxFirebaseProvider.md)

docs/api/ReactReduxFirebaseProvider.md

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
## ReactReduxFirebaseProvider
88

9+
- **See: <http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/ReactReduxFirebaseProvider.html>**
10+
911
Provider for context containing extended firebase instance created
1012
by react-redux-firebase
1113

docs/api/ReduxFirestoreProvider.md

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
## ReduxFirestoreProvider
88

9+
- **See: <http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/ReduxFirestoreProvider.html>**
10+
911
Provider for context containing extended firestore instance created
1012
by react-redux-firebase
1113

docs/api/firebaseInstance.md

+524
Large diffs are not rendered by default.

docs/api/getFirebase.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# getFirebase
22

3-
Expose Firebase instance created internally, which is the same as [props.firebase](/docs/api/props-firebase.md). Useful for
3+
Expose [extended Firebase instance](/docs/api/firebaseInstance.md) created internally. Useful for
44
integrations into external libraries such as redux-thunk and redux-observable.
55

66
The methods which are available are documented in [firebaseInstance](/docs/api/firebaseInstance.md)

docs/api/props-firebase.md

-324
This file was deleted.

docs/api/reducer.md

+2-11
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,9 @@
22

33
### Table of Contents
44

5-
- [firebaseReducer](#firebasereducer)
5+
- [reducer](#reducer)
66

7-
## firebaseReducer
8-
9-
Main reducer for react-redux-firebase. This function is called
10-
automatically by redux every time an action is fired. Based on which action
11-
is called and its payload, the reducer will update redux state with relevant
12-
changes. `firebaseReducer` is made up of multiple "slice reducers"
13-
([outlined in reducers docs](/docs/recipes/reducers.md)) combined using
14-
[`combineReducers`](https://redux.js.org/docs/api/combineReducers.html)
15-
following the patterns outlined in
16-
[the redux docs](https://redux.js.org/docs/recipes/StructuringReducers.html).
7+
## reducer
178

189
**Parameters**
1910

docs/api/useFirebaseConnect.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## useFirebaseConnect
88

9-
- **See: <http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/useFirestore.html>**
9+
- **See: <http://docs.react-redux-firebase.com/history/v3.0.0/docs/api/useFirebaseConnect.html>**
1010

1111
Hook that automatically listens/unListens to provided firebase paths
1212
using React's useEffect hook.

0 commit comments

Comments
 (0)