Skip to content

Commit c2809b7

Browse files
schmidt-sebastianschmidt-sebastian
committed
Merge branch 'master' into mrschmidt/rest
2 parents dc7241a + 94986e6 commit c2809b7

File tree

395 files changed

+7721
-1186
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

395 files changed

+7721
-1186
lines changed

‎.changeset/calm-apes-collect.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
'@firebase/webchannel-wrapper': minor
3+
---
4+
5+
Upgrade to the latest version of Google Closure Library and Compiler. This dependency will be
6+
necessary for future updates to the @firebase/firestore package. Developers will not need to
7+
make any changes to their code to handle this change.

‎config/functions/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
"description": "Cloud Functions for Firebase",
44
"dependencies": {
55
"cors": "2.8.5",
6-
"firebase-admin": "8.13.0",
7-
"firebase-functions": "3.7.0"
6+
"firebase-admin": "9.0.0",
7+
"firebase-functions": "3.8.0"
88
},
99
"private": true,
1010
"engines": {

‎docs-exp/firestore.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md)
4+
5+
## firestore package
6+
7+
| Entry Point | Description |
8+
| --- | --- |
9+
| [/](./firestore_.md) | |
10+
| [/lite](./firestore_lite.md) | |
11+

‎docs-exp/firestore_.adddoc.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [addDoc](./firestore_.adddoc.md)
4+
5+
## addDoc() function
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export function addDoc<T>(
11+
reference: CollectionReference<T>,
12+
data: T
13+
): Promise<DocumentReference<T>>;
14+
```
15+
16+
## Parameters
17+
18+
| Parameter | Type | Description |
19+
| --- | --- | --- |
20+
| reference | [CollectionReference](./firestore_.collectionreference.md)<!-- -->&lt;T&gt; | |
21+
| data | T | |
22+
23+
<b>Returns:</b>
24+
25+
Promise&lt;[DocumentReference](./firestore_.documentreference.md)<!-- -->&lt;T&gt;&gt;
26+

‎docs-exp/firestore_.arrayremove.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [arrayRemove](./firestore_.arrayremove.md)
4+
5+
## arrayRemove() function
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export function arrayRemove(...elements: any[]): FieldValue;
11+
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| elements | any\[\] | |
18+
19+
<b>Returns:</b>
20+
21+
[FieldValue](./firestore_.fieldvalue.md)
22+

‎docs-exp/firestore_.arrayunion.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [arrayUnion](./firestore_.arrayunion.md)
4+
5+
## arrayUnion() function
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export function arrayUnion(...elements: any[]): FieldValue;
11+
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| elements | any\[\] | |
18+
19+
<b>Returns:</b>
20+
21+
[FieldValue](./firestore_.fieldvalue.md)
22+

‎docs-exp/firestore_.blob.frombase64string.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [Blob](./firestore_.blob.md) &gt; [fromBase64String](./firestore_.blob.frombase64string.md)
4+
5+
## Blob.fromBase64String() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
static fromBase64String(base64: string): Blob;
11+
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| base64 | string | |
18+
19+
<b>Returns:</b>
20+
21+
[Blob](./firestore_.blob.md)
22+

‎docs-exp/firestore_.blob.fromuint8array.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [Blob](./firestore_.blob.md) &gt; [fromUint8Array](./firestore_.blob.fromuint8array.md)
4+
5+
## Blob.fromUint8Array() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
static fromUint8Array(array: Uint8Array): Blob;
11+
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| array | Uint8Array | |
18+
19+
<b>Returns:</b>
20+
21+
[Blob](./firestore_.blob.md)
22+

‎docs-exp/firestore_.blob.isequal.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [Blob](./firestore_.blob.md) &gt; [isEqual](./firestore_.blob.isequal.md)
4+
5+
## Blob.isEqual() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
isEqual(other: Blob): boolean;
11+
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| other | [Blob](./firestore_.blob.md) | |
18+
19+
<b>Returns:</b>
20+
21+
boolean
22+

‎docs-exp/firestore_.blob.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [Blob](./firestore_.blob.md)
4+
5+
## Blob class
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export class Blob
11+
```
12+
13+
## Methods
14+
15+
| Method | Modifiers | Description |
16+
| --- | --- | --- |
17+
| [fromBase64String(base64)](./firestore_.blob.frombase64string.md) | <code>static</code> | |
18+
| [fromUint8Array(array)](./firestore_.blob.fromuint8array.md) | <code>static</code> | |
19+
| [isEqual(other)](./firestore_.blob.isequal.md) | | |
20+
| [toBase64()](./firestore_.blob.tobase64.md) | | |
21+
| [toUint8Array()](./firestore_.blob.touint8array.md) | | |
22+

‎docs-exp/firestore_.blob.tobase64.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [Blob](./firestore_.blob.md) &gt; [toBase64](./firestore_.blob.tobase64.md)
4+
5+
## Blob.toBase64() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
toBase64(): string;
11+
```
12+
<b>Returns:</b>
13+
14+
string
15+

‎docs-exp/firestore_.blob.touint8array.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [Blob](./firestore_.blob.md) &gt; [toUint8Array](./firestore_.blob.touint8array.md)
4+
5+
## Blob.toUint8Array() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
toUint8Array(): Uint8Array;
11+
```
12+
<b>Returns:</b>
13+
14+
Uint8Array
15+

‎docs-exp/firestore_.cache_size_unlimited.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [CACHE\_SIZE\_UNLIMITED](./firestore_.cache_size_unlimited.md)
4+
5+
## CACHE\_SIZE\_UNLIMITED variable
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
CACHE_SIZE_UNLIMITED: number
11+
```

‎docs-exp/firestore_.clearindexeddbpersistence.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [clearIndexedDbPersistence](./firestore_.clearindexeddbpersistence.md)
4+
5+
## clearIndexedDbPersistence() function
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export function clearIndexedDbPersistence(
11+
firestore: FirebaseFirestore
12+
): Promise<void>;
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| firestore | [FirebaseFirestore](./firestore_.firebasefirestore.md) | |
20+
21+
<b>Returns:</b>
22+
23+
Promise&lt;void&gt;
24+

‎docs-exp/firestore_.collection.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [collection](./firestore_.collection.md)
4+
5+
## collection() function
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export function collection(
11+
firestore: FirebaseFirestore,
12+
collectionPath: string
13+
): CollectionReference<DocumentData>;
14+
```
15+
16+
## Parameters
17+
18+
| Parameter | Type | Description |
19+
| --- | --- | --- |
20+
| firestore | [FirebaseFirestore](./firestore_.firebasefirestore.md) | |
21+
| collectionPath | string | |
22+
23+
<b>Returns:</b>
24+
25+
[CollectionReference](./firestore_.collectionreference.md)<!-- -->&lt;[DocumentData](./firestore_.documentdata.md)<!-- -->&gt;
26+

‎docs-exp/firestore_.collection_1.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [collection](./firestore_.collection_1.md)
4+
5+
## collection() function
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export function collection(
11+
reference: CollectionReference<unknown>,
12+
collectionPath: string
13+
): CollectionReference<DocumentData>;
14+
```
15+
16+
## Parameters
17+
18+
| Parameter | Type | Description |
19+
| --- | --- | --- |
20+
| reference | [CollectionReference](./firestore_.collectionreference.md)<!-- -->&lt;unknown&gt; | |
21+
| collectionPath | string | |
22+
23+
<b>Returns:</b>
24+
25+
[CollectionReference](./firestore_.collectionreference.md)<!-- -->&lt;[DocumentData](./firestore_.documentdata.md)<!-- -->&gt;
26+

‎docs-exp/firestore_.collection_2.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [collection](./firestore_.collection_2.md)
4+
5+
## collection() function
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export function collection(
11+
reference: DocumentReference,
12+
collectionPath: string
13+
): CollectionReference<DocumentData>;
14+
```
15+
16+
## Parameters
17+
18+
| Parameter | Type | Description |
19+
| --- | --- | --- |
20+
| reference | [DocumentReference](./firestore_.documentreference.md) | |
21+
| collectionPath | string | |
22+
23+
<b>Returns:</b>
24+
25+
[CollectionReference](./firestore_.collectionreference.md)<!-- -->&lt;[DocumentData](./firestore_.documentdata.md)<!-- -->&gt;
26+

‎docs-exp/firestore_.collectiongroup.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [collectionGroup](./firestore_.collectiongroup.md)
4+
5+
## collectionGroup() function
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export function collectionGroup(
11+
firestore: FirebaseFirestore,
12+
collectionId: string
13+
): Query<DocumentData>;
14+
```
15+
16+
## Parameters
17+
18+
| Parameter | Type | Description |
19+
| --- | --- | --- |
20+
| firestore | [FirebaseFirestore](./firestore_.firebasefirestore.md) | |
21+
| collectionId | string | |
22+
23+
<b>Returns:</b>
24+
25+
[Query](./firestore_.query.md)<!-- -->&lt;[DocumentData](./firestore_.documentdata.md)<!-- -->&gt;
26+

‎docs-exp/firestore_.collectionreference.id.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [CollectionReference](./firestore_.collectionreference.md) &gt; [id](./firestore_.collectionreference.id.md)
4+
5+
## CollectionReference.id property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
readonly id: string;
11+
```

0 commit comments

Comments
 (0)