kylefang/react-native-firebase
1
0
Fork 0
mirror of https://github.com/zhigang1992/react-native-firebase.git synced 2026-04-26 23:05:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(*): corrections (#3676)

Browse Source
This commit is contained in:
Russell Wheatley
2020-05-22 11:18:38 +01:00
committed by GitHub
parent d2a61f5e7f
commit 8a35db6f36
4 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/app/usage.md
View File

@@ -14,7 +14,7 @@ The App module is available by default once you have installed the React Native
# Secondary Apps # Secondary Apps
Unlike the Firebase Web SDK, there is no need to manually call the [`initalizeApp`](https://firebase.google.com/docs/web/setup#add-sdks-initialize) Unlike the Firebase Web SDK, there is no need to manually call the [`initializeApp`](https://firebase.google.com/docs/web/setup#add-sdks-initialize)
method with your project credentials. The native Android & iOS SDKs automatically connect to your Firebase project using method with your project credentials. The native Android & iOS SDKs automatically connect to your Firebase project using
the credentials provided during the [Getting Started](/) installation steps. The app module does however provide support the credentials provided during the [Getting Started](/) installation steps. The app module does however provide support
for manually initializing secondary Firebase app instances. for manually initializing secondary Firebase app instances.
@@ -33,7 +33,7 @@ Currently, the native Firebase SDKs only provide functionality for creating seco
## Initializing secondary apps ## Initializing secondary apps
The module exposes an `initalizeApp` method which accepts arguments containing the credentials and options for your secondary The module exposes an `initializeApp` method which accepts arguments containing the credentials and options for your secondary
apps: apps:
```js ```js
@@ -54,7 +54,7 @@ const config = {
name: 'SECONDARY_APP', name: 'SECONDARY_APP',
}; };
await firebase.initalizeApp(credentials, config); await firebase.initializeApp(credentials, config);
``` ```
Once created, you can confirm the app instance has been created by accessing the `apps` property on the module: Once created, you can confirm the app instance has been created by accessing the `apps` property on the module:
@@ -82,7 +82,7 @@ import firebase from '@react-native-firebase/app';
import auth from '@react-native-firebase/auth'; import auth from '@react-native-firebase/auth';
// create secondary app as described above // create secondary app as described above
const secondaryApp = await firebase.initalizeApp(credentials, config); const secondaryApp = await firebase.initializeApp(credentials, config);
// Example using auth with passing the secondary app instance // Example using auth with passing the secondary app instance
auth(secondaryApp).currentUser; auth(secondaryApp).currentUser;

2
docs/database/usage/index.md
View File

@@ -19,7 +19,7 @@ yarn add @react-native-firebase/app
yarn add @react-native-firebase/database yarn add @react-native-firebase/database
# If you're developing your app using iOS, run this command # If you're developing your app using iOS, run this command
cd ios/ && pod install cd ios/ && pod install && cd ..
``` ```
If you're using an older version of React Native without autolinking support, or wish to integrate into an existing project, If you're using an older version of React Native without autolinking support, or wish to integrate into an existing project,

2
docs/index.md
View File

@@ -213,7 +213,7 @@ Open your projects `/ios/Podfile` and add any of the globals shown below to the
```ruby ```ruby
# Override Firebase SDK Version # Override Firebase SDK Version
$FirebaseSDKVersion = '6.8.1' $FirebaseSDKVersion = '6.13.0'
# Override Fabric SDK Version # Override Fabric SDK Version
$FabricSDKVersion = '1.6.0' $FabricSDKVersion = '1.6.0'

2
docs/migrating-to-v6.md
View File

@@ -419,7 +419,7 @@ No breaking changes.
- The `Reference` class has undergone a rewrite. In previous versions, chaining invalid methods together on a query was possible. In version 6, the functionality now replicates the Firebase Web SDK. - The `Reference` class has undergone a rewrite. In previous versions, chaining invalid methods together on a query was possible. In version 6, the functionality now replicates the Firebase Web SDK.
- Please thoroughly test your database queries. - Please thoroughly test your database queries.
- Internal JavaScript validation has been added and will throw a JavaScript error is methods are called with incorrect parameters. - Internal JavaScript validation has been added and will throw a JavaScript error if methods are called with incorrect parameters.
- All query based modifiers are now validated as per the Web SDK spec. In v5 it is possible to chain queries which are not allowed together causing native errors (e.g. `.orderByKey().orderByPriority()`, `.startAt('foo', 'bar').orderByKey()` etc). Doing so in v6 will now throw an error to keep it in-line with the Web SDK. - All query based modifiers are now validated as per the Web SDK spec. In v5 it is possible to chain queries which are not allowed together causing native errors (e.g. `.orderByKey().orderByPriority()`, `.startAt('foo', 'bar').orderByKey()` etc). Doing so in v6 will now throw an error to keep it in-line with the Web SDK.
- `Reference.push` now correctly mimics the Web SDK, returning a thenable reference. - `Reference.push` now correctly mimics the Web SDK, returning a thenable reference.