Skip to content

Commit ce149d5

Browse files
committed
update import syntax in readmes and messages
1 parent 602ec18 commit ce149d5

File tree

5 files changed

+15
-15
lines changed

5 files changed

+15
-15
lines changed

packages-exp/firebase-exp/compat/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import firebase from 'firebase/app';
3232
import 'firebase/<PACKAGE>';
3333
3434
Typescript:
35-
import * as firebase from 'firebase/app';
35+
import firebase from 'firebase/app';
3636
import 'firebase/<PACKAGE>';
3737
`);
3838

packages/firebase/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ var app = firebase.initializeApp({ ... });
9292
If you are using ES6 imports or TypeScript:
9393

9494
```js
95-
import * as firebase from 'firebase';
95+
import firebase from 'firebase';
9696
var app = firebase.initializeApp({ ... });
9797
```
9898

@@ -147,7 +147,7 @@ services you use:
147147

148148
```js
149149
// This import loads the firebase namespace along with all its type information.
150-
import * as firebase from 'firebase/app';
150+
import firebase from 'firebase/app';
151151

152152
// These imports load individual services into the firebase namespace.
153153
import 'firebase/auth';
@@ -187,7 +187,7 @@ you should do:
187187

188188
```js
189189
// This import loads the firebase namespace.
190-
import * as firebase from 'firebase/app';
190+
import firebase from 'firebase/app';
191191

192192
// These imports load individual services into the firebase namespace.
193193
import 'firebase/auth';

packages/firebase/src/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import firebase from 'firebase/app';
3232
import 'firebase/<PACKAGE>';
3333
3434
Typescript:
35-
import * as firebase from 'firebase/app';
35+
import firebase from 'firebase/app';
3636
import 'firebase/<PACKAGE>';
3737
`);
3838

packages/rxfire/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Make sure to install Firebase and RxJS individually as they are peer dependencie
2626
## Example use:
2727

2828
```ts
29-
import * as firebase from 'firebase/app';
29+
import firebase from 'firebase/app';
3030
import 'firebase/firestore';
3131
import { collectionData } from 'rxfire/firestore';
3232
import { tap } from 'rxjs/operators';
@@ -49,7 +49,7 @@ RxJS provides multiple operators and creation methods for combining observable s
4949
The example below streams a list of "cities" from Firestore and then retrieves their image from a Cloud Storage bucket. Both tasks are asynchronous but RxJS makes it easy to combine these tasks together.
5050

5151
```ts
52-
import * as firebase from 'firebase/app';
52+
import firebase from 'firebase/app';
5353
import 'firebase/firestore';
5454
import 'firebase/storage';
5555
import { collectionData } from 'rxfire/firestore';
@@ -79,7 +79,7 @@ collectionData(citiesRef, 'id')
7979
RxFire is a complementary library to Firebase. It is not meant to wrap the entire Firebase SDK. RxFire's purpose is to simplify async streams from Firebase. You need to import the Firebase SDK and initialize an app before using RxFire.
8080

8181
```ts
82-
import * as firebase from 'firebase/app';
82+
import firebase from 'firebase/app';
8383
import 'firebase/storage'; // import only the features needed
8484
import { getDownloadURL } from 'rxfire/storage';
8585

@@ -104,7 +104,7 @@ import { } from 'rxfire/functions';
104104
RxFire is a set of functions. Most functions create observables and from there you can use regular RxJS operators. Some functions are custom operators. But at the end of the day, it's all just functions. This is important for **tree shaking**. Any unused functions are stripped from your final build if you use a module bundler like Webpack or Rollup.
105105

106106
```ts
107-
import * as firebase from 'firebase/app';
107+
import firebase from 'firebase/app';
108108
import 'firebase/storage';
109109
import { getDownloadURL, put /* not used! */ } 'rxfire/storage';
110110

packages/rxfire/docs/storage.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The `fromTask()` function creates an observable that emits progress changes.
1515
#### TypeScript Example
1616
```ts
1717
import { fromTask } from 'rxfire/storage';
18-
import * as firebase from 'firebase';
18+
import firebase from 'firebase';
1919
import 'firebase/storage';
2020

2121
// Set up Firebase
@@ -43,7 +43,7 @@ The `percentage()` function creates an observable that emits percentage of the u
4343
#### TypeScript Example
4444
```ts
4545
import { percentage } from 'rxfire/storage';
46-
import * as firebase from 'firebase';
46+
import firebase from 'firebase';
4747
import 'firebase/storage';
4848

4949
// Set up Firebase
@@ -73,7 +73,7 @@ The `getDownloadURL()` function creates an observable that emits the URL of the
7373
#### TypeScript Example
7474
```ts
7575
import { getDownloadURL } from 'rxfire/storage';
76-
import * as firebase from 'firebase';
76+
import firebase from 'firebase';
7777
import 'firebase/storage';
7878

7979
// Set up Firebase
@@ -100,7 +100,7 @@ The `getMetadata()` function creates an observable that emits the URL of the fil
100100
#### TypeScript Example
101101
```ts
102102
import { getMetadata } from 'rxfire/storage';
103-
import * as firebase from 'firebase';
103+
import firebase from 'firebase';
104104
import 'firebase/storage';
105105

106106
// Set up Firebase
@@ -127,7 +127,7 @@ The `put()` function creates an observable that emits the upload progress of a f
127127
#### TypeScript Example
128128
```ts
129129
import { put } from 'rxfire/storage';
130-
import * as firebase from 'firebase';
130+
import firebase from 'firebase';
131131
import 'firebase/storage';
132132

133133
// Set up Firebase
@@ -157,7 +157,7 @@ The `putString()` function creates an observable that emits the upload progress
157157
#### TypeScript Example
158158
```ts
159159
import { putString } from 'rxfire/storage';
160-
import * as firebase from 'firebase';
160+
import firebase from 'firebase';
161161
import 'firebase/storage';
162162

163163
// Set up Firebase

0 commit comments

Comments
 (0)