Skip to content

Commit c147129

Browse files
Feiyang1Feiyang1
committed
update ref docs
1 parent 056deeb commit c147129

File tree

48 files changed

+135
-145
lines changed

Some content is hidden

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

48 files changed

+135
-145
lines changed

‎common/api-review/functions-exp.api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export function getFunctions(app: FirebaseApp, regionOrCustomDomain?: string): F
1616
export function httpsCallable(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable;
1717

1818
// @public
19-
export function useFunctionsEmulator(functionsInstance: Functions, origin: string): void;
19+
export function useFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;
2020

2121

2222
// (No @packageDocumentation comment for this package)

‎docs-exp/firestore_.collection.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
```typescript
1010
export function collection(
1111
firestore: FirebaseFirestore,
12-
collectionPath: string
12+
path: string,
13+
...pathComponents: string[]
1314
): CollectionReference<DocumentData>;
1415
```
1516

@@ -18,7 +19,8 @@ export function collection(
1819
| Parameter | Type | Description |
1920
| --- | --- | --- |
2021
| firestore | [FirebaseFirestore](./firestore_.firebasefirestore.md) | |
21-
| collectionPath | string | |
22+
| path | string | |
23+
| pathComponents | string\[\] | |
2224

2325
<b>Returns:</b>
2426

‎docs-exp/firestore_.collection_1.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
```typescript
1010
export function collection(
1111
reference: CollectionReference<unknown>,
12-
collectionPath: string
12+
path: string,
13+
...pathComponents: string[]
1314
): CollectionReference<DocumentData>;
1415
```
1516

@@ -18,7 +19,8 @@ export function collection(
1819
| Parameter | Type | Description |
1920
| --- | --- | --- |
2021
| reference | [CollectionReference](./firestore_.collectionreference.md)<!-- -->&lt;unknown&gt; | |
21-
| collectionPath | string | |
22+
| path | string | |
23+
| pathComponents | string\[\] | |
2224

2325
<b>Returns:</b>
2426

‎docs-exp/firestore_.collection_2.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
```typescript
1010
export function collection(
1111
reference: DocumentReference,
12-
collectionPath: string
12+
path: string,
13+
...pathComponents: string[]
1314
): CollectionReference<DocumentData>;
1415
```
1516

@@ -18,7 +19,8 @@ export function collection(
1819
| Parameter | Type | Description |
1920
| --- | --- | --- |
2021
| reference | [DocumentReference](./firestore_.documentreference.md) | |
21-
| collectionPath | string | |
22+
| path | string | |
23+
| pathComponents | string\[\] | |
2224

2325
<b>Returns:</b>
2426

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

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎docs-exp/firestore_.collectionreference.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,5 @@ export class CollectionReference<T = DocumentData> extends Query<T>
2424
2525
| Method | Modifiers | Description |
2626
| --- | --- | --- |
27-
| [doc(documentPath)](./firestore_.collectionreference.doc.md) | | |
2827
| [withConverter(converter)](./firestore_.collectionreference.withconverter.md) | | |
2928

‎docs-exp/firestore_.doc.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
```typescript
1010
export function doc(
1111
firestore: FirebaseFirestore,
12-
documentPath: string
12+
path: string,
13+
...pathComponents: string[]
1314
): DocumentReference<DocumentData>;
1415
```
1516

@@ -18,7 +19,8 @@ export function doc(
1819
| Parameter | Type | Description |
1920
| --- | --- | --- |
2021
| firestore | [FirebaseFirestore](./firestore_.firebasefirestore.md) | |
21-
| documentPath | string | |
22+
| path | string | |
23+
| pathComponents | string\[\] | |
2224

2325
<b>Returns:</b>
2426

‎docs-exp/firestore_.doc_1.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
```typescript
1010
export function doc<T>(
1111
reference: CollectionReference<T>,
12-
documentPath?: string
12+
path?: string,
13+
...pathComponents: string[]
1314
): DocumentReference<T>;
1415
```
1516

@@ -18,7 +19,8 @@ export function doc<T>(
1819
| Parameter | Type | Description |
1920
| --- | --- | --- |
2021
| reference | [CollectionReference](./firestore_.collectionreference.md)<!-- -->&lt;T&gt; | |
21-
| documentPath | string | |
22+
| path | string | |
23+
| pathComponents | string\[\] | |
2224

2325
<b>Returns:</b>
2426

‎docs-exp/firestore_.doc_2.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
```typescript
1010
export function doc(
1111
reference: DocumentReference<unknown>,
12-
documentPath: string
12+
path: string,
13+
...pathComponents: string[]
1314
): DocumentReference<DocumentData>;
1415
```
1516

@@ -18,7 +19,8 @@ export function doc(
1819
| Parameter | Type | Description |
1920
| --- | --- | --- |
2021
| reference | [DocumentReference](./firestore_.documentreference.md)<!-- -->&lt;unknown&gt; | |
21-
| documentPath | string | |
22+
| path | string | |
23+
| pathComponents | string\[\] | |
2224

2325
<b>Returns:</b>
2426

‎docs-exp/firestore_.documentreference.collection.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎docs-exp/firestore_.documentreference.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,5 @@ export class DocumentReference<T = DocumentData>
2525

2626
| Method | Modifiers | Description |
2727
| --- | --- | --- |
28-
| [collection(collectionPath)](./firestore_.documentreference.collection.md) | | |
2928
| [withConverter(converter)](./firestore_.documentreference.withconverter.md) | | |
3029

‎docs-exp/firestore_.documentsnapshot._constructor_.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
## DocumentSnapshot.(constructor)
66

7+
Constructs a new instance of the `DocumentSnapshot` class
8+
79
<b>Signature:</b>
810

911
```typescript

‎docs-exp/firestore_.documentsnapshot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export class DocumentSnapshot<T = DocumentData>
1414

1515
| Constructor | Modifiers | Description |
1616
| --- | --- | --- |
17-
| [(constructor)()](./firestore_.documentsnapshot._constructor_.md) | | |
17+
| [(constructor)()](./firestore_.documentsnapshot._constructor_.md) | | Constructs a new instance of the <code>DocumentSnapshot</code> class |
1818

1919
## Properties
2020

‎docs-exp/firestore_.enableindexeddbpersistence.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88

99
```typescript
1010
export function enableIndexedDbPersistence(
11-
firestore: FirebaseFirestore
11+
firestore: FirebaseFirestore,
12+
persistenceSettings?: PersistenceSettings
1213
): Promise<void>;
1314
```
1415

@@ -17,6 +18,7 @@ export function enableIndexedDbPersistence(
1718
| Parameter | Type | Description |
1819
| --- | --- | --- |
1920
| firestore | [FirebaseFirestore](./firestore_.firebasefirestore.md) | |
21+
| persistenceSettings | [PersistenceSettings](./firestore_.persistencesettings.md) | |
2022

2123
<b>Returns:</b>
2224

‎docs-exp/firestore_.fieldpath._constructor_.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
## FieldPath.(constructor)
66

7+
Constructs a new instance of the `FieldPath` class
8+
79
<b>Signature:</b>
810

911
```typescript

‎docs-exp/firestore_.fieldpath.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export class FieldPath
1414

1515
| Constructor | Modifiers | Description |
1616
| --- | --- | --- |
17-
| [(constructor)(fieldNames)](./firestore_.fieldpath._constructor_.md) | | |
17+
| [(constructor)(fieldNames)](./firestore_.fieldpath._constructor_.md) | | Constructs a new instance of the <code>FieldPath</code> class |
1818

1919
## Methods
2020

‎docs-exp/firestore_.geopoint._constructor_.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
## GeoPoint.(constructor)
66

7+
Constructs a new instance of the `GeoPoint` class
8+
79
<b>Signature:</b>
810

911
```typescript

‎docs-exp/firestore_.geopoint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export class GeoPoint
1414

1515
| Constructor | Modifiers | Description |
1616
| --- | --- | --- |
17-
| [(constructor)(latitude, longitude)](./firestore_.geopoint._constructor_.md) | | |
17+
| [(constructor)(latitude, longitude)](./firestore_.geopoint._constructor_.md) | | Constructs a new instance of the <code>GeoPoint</code> class |
1818

1919
## Properties
2020

‎docs-exp/firestore_.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,18 @@
3333
| [arrayRemove(elements)](./firestore_.arrayremove.md) | |
3434
| [arrayUnion(elements)](./firestore_.arrayunion.md) | |
3535
| [clearIndexedDbPersistence(firestore)](./firestore_.clearindexeddbpersistence.md) | |
36-
| [collection(firestore, collectionPath)](./firestore_.collection.md) | |
37-
| [collection(reference, collectionPath)](./firestore_.collection_1.md) | |
38-
| [collection(reference, collectionPath)](./firestore_.collection_2.md) | |
36+
| [collection(firestore, path, pathComponents)](./firestore_.collection.md) | |
37+
| [collection(reference, path, pathComponents)](./firestore_.collection_1.md) | |
38+
| [collection(reference, path, pathComponents)](./firestore_.collection_2.md) | |
3939
| [collectionGroup(firestore, collectionId)](./firestore_.collectiongroup.md) | |
4040
| [deleteDoc(reference)](./firestore_.deletedoc.md) | |
4141
| [deleteField()](./firestore_.deletefield.md) | |
4242
| [disableNetwork(firestore)](./firestore_.disablenetwork.md) | |
43-
| [doc(firestore, documentPath)](./firestore_.doc.md) | |
44-
| [doc(reference, documentPath)](./firestore_.doc_1.md) | |
45-
| [doc(reference, documentPath)](./firestore_.doc_2.md) | |
43+
| [doc(firestore, path, pathComponents)](./firestore_.doc.md) | |
44+
| [doc(reference, path, pathComponents)](./firestore_.doc_1.md) | |
45+
| [doc(reference, path, pathComponents)](./firestore_.doc_2.md) | |
4646
| [documentId()](./firestore_.documentid.md) | |
47-
| [enableIndexedDbPersistence(firestore)](./firestore_.enableindexeddbpersistence.md) | |
47+
| [enableIndexedDbPersistence(firestore, persistenceSettings)](./firestore_.enableindexeddbpersistence.md) | |
4848
| [enableMultiTabIndexedDbPersistence(firestore)](./firestore_.enablemultitabindexeddbpersistence.md) | |
4949
| [enableNetwork(firestore)](./firestore_.enablenetwork.md) | |
5050
| [endAt(snapshot)](./firestore_.endat.md) | |
@@ -101,6 +101,7 @@
101101
| [DocumentData](./firestore_.documentdata.md) | |
102102
| [FirestoreDataConverter](./firestore_.firestoredataconverter.md) | |
103103
| [FirestoreError](./firestore_.firestoreerror.md) | |
104+
| [PersistenceSettings](./firestore_.persistencesettings.md) | |
104105
| [Settings](./firestore_.settings.md) | |
105106
| [SnapshotListenOptions](./firestore_.snapshotlistenoptions.md) | |
106107
| [SnapshotOptions](./firestore_.snapshotoptions.md) | |

‎docs-exp/firestore_.persistencesettings.forceownership.md

Lines changed: 11 additions & 0 deletions
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; [PersistenceSettings](./firestore_.persistencesettings.md) &gt; [forceOwnership](./firestore_.persistencesettings.forceownership.md)
4+
5+
## PersistenceSettings.forceOwnership property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
forceOwnership?: boolean;
11+
```

‎docs-exp/firestore_.persistencesettings.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
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; [PersistenceSettings](./firestore_.persistencesettings.md)
4+
5+
## PersistenceSettings interface
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export interface PersistenceSettings
11+
```
12+
13+
## Properties
14+
15+
| Property | Type | Description |
16+
| --- | --- | --- |
17+
| [forceOwnership](./firestore_.persistencesettings.forceownership.md) | boolean | |
18+

‎docs-exp/firestore_.query._constructor_.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
## Query.(constructor)
66

7+
Constructs a new instance of the `Query` class
8+
79
<b>Signature:</b>
810

911
```typescript

‎docs-exp/firestore_.timestamp._constructor_.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
## Timestamp.(constructor)
66

7+
Constructs a new instance of the `Timestamp` class
8+
79
<b>Signature:</b>
810

911
```typescript

‎docs-exp/firestore_.timestamp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export class Timestamp
1414

1515
| Constructor | Modifiers | Description |
1616
| --- | --- | --- |
17-
| [(constructor)(seconds, nanoseconds)](./firestore_.timestamp._constructor_.md) | | |
17+
| [(constructor)(seconds, nanoseconds)](./firestore_.timestamp._constructor_.md) | | Constructs a new instance of the <code>Timestamp</code> class |
1818

1919
## Properties
2020

‎docs-exp/firestore_.wherefilterop.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ export type WhereFilterOp =
1111
| '<'
1212
| '<='
1313
| '=='
14+
| '!='
1415
| '>='
1516
| '>'
1617
| 'array-contains'
1718
| 'in'
18-
| 'array-contains-any';
19+
| 'array-contains-any'
20+
| 'not-in';
1921
```

‎docs-exp/firestore_lite.collection.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
```typescript
1010
export function collection(
1111
firestore: FirebaseFirestore,
12-
collectionPath: string
12+
path: string,
13+
...pathComponents: string[]
1314
): CollectionReference<DocumentData>;
1415
```
1516

@@ -18,7 +19,8 @@ export function collection(
1819
| Parameter | Type | Description |
1920
| --- | --- | --- |
2021
| firestore | [FirebaseFirestore](./firestore_lite.firebasefirestore.md) | |
21-
| collectionPath | string | |
22+
| path | string | |
23+
| pathComponents | string\[\] | |
2224

2325
<b>Returns:</b>
2426

0 commit comments

Comments
 (0)