Skip to content

Commit d075807

Browse files
committed
yarn docgen devsite
1 parent b34e340 commit d075807

25 files changed

+389
-407
lines changed

docs-devsite/firestore_.aggregatequerysnapshot.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ The results of executing an aggregation query.
1515
<b>Signature:</b>
1616

1717
```typescript
18-
export declare class AggregateQuerySnapshot<T extends AggregateSpec>
18+
export declare class AggregateQuerySnapshot<AggregateSpecType extends AggregateSpec, AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>
1919
```
2020

2121
## Properties
2222

2323
| Property | Modifiers | Type | Description |
2424
| --- | --- | --- | --- |
25-
| [query](./firestore_.aggregatequerysnapshot.md#aggregatequerysnapshotquery) | | [Query](./firestore_.query.md#query_class)<!-- -->&lt;unknown&gt; | The underlying query over which the aggregations recorded in this <code>AggregateQuerySnapshot</code> were performed. |
25+
| [query](./firestore_.aggregatequerysnapshot.md#aggregatequerysnapshotquery) | | [Query](./firestore_.query.md#query_class)<!-- -->&lt;AppType, DbType&gt; | The underlying query over which the aggregations recorded in this <code>AggregateQuerySnapshot</code> were performed. |
2626
| [type](./firestore_.aggregatequerysnapshot.md#aggregatequerysnapshottype) | | (not declared) | A type string to uniquely identify instances of this class. |
2727

2828
## Methods
@@ -38,7 +38,7 @@ The underlying query over which the aggregations recorded in this `AggregateQuer
3838
<b>Signature:</b>
3939

4040
```typescript
41-
readonly query: Query<unknown>;
41+
readonly query: Query<AppType, DbType>;
4242
```
4343

4444
## AggregateQuerySnapshot.type
@@ -60,11 +60,11 @@ The keys of the returned object will be the same as those of the `AggregateSpec`
6060
<b>Signature:</b>
6161

6262
```typescript
63-
data(): AggregateSpecData<T>;
63+
data(): AggregateSpecData<AggregateSpecType>;
6464
```
6565
<b>Returns:</b>
6666

67-
[AggregateSpecData](./firestore_.md#aggregatespecdata)<!-- -->&lt;T&gt;
67+
[AggregateSpecData](./firestore_.md#aggregatespecdata)<!-- -->&lt;AggregateSpecType&gt;
6868

6969
The results of the aggregations performed over the underlying query.
7070

docs-devsite/firestore_.collectionreference.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@ A `CollectionReference` object can be used for adding documents, getting documen
1515
<b>Signature:</b>
1616

1717
```typescript
18-
export declare class CollectionReference<T = DocumentData> extends Query<T>
18+
export declare class CollectionReference<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData> extends Query<AppType, DbType>
1919
```
20-
<b>Extends:</b> [Query](./firestore_.query.md#query_class)<!-- -->&lt;T&gt;
20+
<b>Extends:</b> [Query](./firestore_.query.md#query_class)<!-- -->&lt;AppType, DbType&gt;
2121
2222
## Properties
2323
2424
| Property | Modifiers | Type | Description |
2525
| --- | --- | --- | --- |
2626
| [id](./firestore_.collectionreference.md#collectionreferenceid) | | string | The collection's identifier. |
27-
| [parent](./firestore_.collectionreference.md#collectionreferenceparent) | | [DocumentReference](./firestore_.documentreference.md#documentreference_class)<!-- -->&lt;[DocumentData](./firestore_.documentdata.md#documentdata_interface)<!-- -->&gt; \| null | A reference to the containing <code>DocumentReference</code> if this is a subcollection. If this isn't a subcollection, the reference is null. |
27+
| [parent](./firestore_.collectionreference.md#collectionreferenceparent) | | [DocumentReference](./firestore_.documentreference.md#documentreference_class)<!-- -->&lt;[DocumentData](./firestore_.md#documentdata)<!-- -->, [DocumentData](./firestore_.md#documentdata)<!-- -->&gt; \| null | A reference to the containing <code>DocumentReference</code> if this is a subcollection. If this isn't a subcollection, the reference is null. |
2828
| [path](./firestore_.collectionreference.md#collectionreferencepath) | | string | A string representing the path of the referenced collection (relative to the root of the database). |
2929
| [type](./firestore_.collectionreference.md#collectionreferencetype) | | (not declared) | The type of this Firestore reference. |
3030
@@ -52,7 +52,7 @@ A reference to the containing `DocumentReference` if this is a subcollection. If
5252
<b>Signature:</b>
5353
5454
```typescript
55-
get parent(): DocumentReference<DocumentData> | null;
55+
get parent(): DocumentReference<DocumentData, DocumentData> | null;
5656
```
5757
5858
## CollectionReference.path
@@ -82,18 +82,18 @@ Applies a custom data converter to this `CollectionReference`<!-- -->, allowing
8282
<b>Signature:</b>
8383
8484
```typescript
85-
withConverter<U>(converter: FirestoreDataConverter<U>): CollectionReference<U>;
85+
withConverter<NewAppType = DocumentData, NewDbType extends DocumentData = NewAppType extends DocumentData ? NewAppType : DocumentData>(converter: FirestoreDataConverter<NewAppType, NewDbType>): CollectionReference<NewAppType, NewDbType>;
8686
```
8787
8888
### Parameters
8989
9090
| Parameter | Type | Description |
9191
| --- | --- | --- |
92-
| converter | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;U&gt; | Converts objects to and from Firestore. |
92+
| converter | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;NewAppType, NewDbType&gt; | Converts objects to and from Firestore. |
9393
9494
<b>Returns:</b>
9595
96-
[CollectionReference](./firestore_.collectionreference.md#collectionreference_class)<!-- -->&lt;U&gt;
96+
[CollectionReference](./firestore_.collectionreference.md#collectionreference_class)<!-- -->&lt;NewAppType, NewDbType&gt;
9797
9898
A `CollectionReference<U>` that uses the provided converter.
9999
@@ -104,7 +104,7 @@ Removes the current converter.
104104
<b>Signature:</b>
105105
106106
```typescript
107-
withConverter(converter: null): CollectionReference<DocumentData>;
107+
withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;
108108
```
109109
110110
### Parameters
@@ -115,7 +115,7 @@ withConverter(converter: null): CollectionReference<DocumentData>;
115115
116116
<b>Returns:</b>
117117
118-
[CollectionReference](./firestore_.collectionreference.md#collectionreference_class)<!-- -->&lt;[DocumentData](./firestore_.documentdata.md#documentdata_interface)<!-- -->&gt;
118+
[CollectionReference](./firestore_.collectionreference.md#collectionreference_class)<!-- -->&lt;[DocumentData](./firestore_.md#documentdata)<!-- -->, [DocumentData](./firestore_.md#documentdata)<!-- -->&gt;
119119
120120
A `CollectionReference<DocumentData>` that does not use a converter.
121121

docs-devsite/firestore_.documentchange.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ A `DocumentChange` represents a change to the documents matching a query. It con
1515
<b>Signature:</b>
1616

1717
```typescript
18-
export declare interface DocumentChange<T = DocumentData>
18+
export declare interface DocumentChange<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>
1919
```
2020

2121
## Properties
2222

2323
| Property | Type | Description |
2424
| --- | --- | --- |
25-
| [doc](./firestore_.documentchange.md#documentchangedoc) | [QueryDocumentSnapshot](./firestore_.querydocumentsnapshot.md#querydocumentsnapshot_class)<!-- -->&lt;T&gt; | The document affected by this change. |
25+
| [doc](./firestore_.documentchange.md#documentchangedoc) | [QueryDocumentSnapshot](./firestore_.querydocumentsnapshot.md#querydocumentsnapshot_class)<!-- -->&lt;AppType, DbType&gt; | The document affected by this change. |
2626
| [newIndex](./firestore_.documentchange.md#documentchangenewindex) | number | The index of the changed document in the result set immediately after this <code>DocumentChange</code> (i.e. supposing that all prior <code>DocumentChange</code> objects and the current <code>DocumentChange</code> object have been applied). Is -1 for 'removed' events. |
2727
| [oldIndex](./firestore_.documentchange.md#documentchangeoldindex) | number | The index of the changed document in the result set immediately prior to this <code>DocumentChange</code> (i.e. supposing that all prior <code>DocumentChange</code> objects have been applied). Is <code>-1</code> for 'added' events. |
2828
| [type](./firestore_.documentchange.md#documentchangetype) | [DocumentChangeType](./firestore_.md#documentchangetype) | The type of change ('added', 'modified', or 'removed'). |
@@ -34,7 +34,7 @@ The document affected by this change.
3434
<b>Signature:</b>
3535

3636
```typescript
37-
readonly doc: QueryDocumentSnapshot<T>;
37+
readonly doc: QueryDocumentSnapshot<AppType, DbType>;
3838
```
3939

4040
## DocumentChange.newIndex

docs-devsite/firestore_.documentdata.md

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

docs-devsite/firestore_.documentreference.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,17 @@ A `DocumentReference` refers to a document location in a Firestore database and
1515
<b>Signature:</b>
1616

1717
```typescript
18-
export declare class DocumentReference<T = DocumentData>
18+
export declare class DocumentReference<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>
1919
```
2020

2121
## Properties
2222

2323
| Property | Modifiers | Type | Description |
2424
| --- | --- | --- | --- |
25-
| [converter](./firestore_.documentreference.md#documentreferenceconverter) | | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;T&gt; \| null | If provided, the <code>FirestoreDataConverter</code> associated with this instance. |
25+
| [converter](./firestore_.documentreference.md#documentreferenceconverter) | | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;AppType, DbType&gt; \| null | If provided, the <code>FirestoreDataConverter</code> associated with this instance. |
2626
| [firestore](./firestore_.documentreference.md#documentreferencefirestore) | | [Firestore](./firestore_.firestore.md#firestore_class) | The [Firestore](./firestore_.firestore.md#firestore_class) instance the document is in. This is useful for performing transactions, for example. |
2727
| [id](./firestore_.documentreference.md#documentreferenceid) | | string | The document's identifier within its collection. |
28-
| [parent](./firestore_.documentreference.md#documentreferenceparent) | | [CollectionReference](./firestore_.collectionreference.md#collectionreference_class)<!-- -->&lt;T&gt; | The collection this <code>DocumentReference</code> belongs to. |
28+
| [parent](./firestore_.documentreference.md#documentreferenceparent) | | [CollectionReference](./firestore_.collectionreference.md#collectionreference_class)<!-- -->&lt;AppType, DbType&gt; | The collection this <code>DocumentReference</code> belongs to. |
2929
| [path](./firestore_.documentreference.md#documentreferencepath) | | string | A string representing the path of the referenced document (relative to the root of the database). |
3030
| [type](./firestore_.documentreference.md#documentreferencetype) | | (not declared) | The type of this Firestore reference. |
3131

@@ -43,7 +43,7 @@ If provided, the `FirestoreDataConverter` associated with this instance.
4343
<b>Signature:</b>
4444

4545
```typescript
46-
readonly converter: FirestoreDataConverter<T> | null;
46+
readonly converter: FirestoreDataConverter<AppType, DbType> | null;
4747
```
4848

4949
## DocumentReference.firestore
@@ -73,7 +73,7 @@ The collection this `DocumentReference` belongs to.
7373
<b>Signature:</b>
7474

7575
```typescript
76-
get parent(): CollectionReference<T>;
76+
get parent(): CollectionReference<AppType, DbType>;
7777
```
7878

7979
## DocumentReference.path
@@ -103,18 +103,18 @@ Applies a custom data converter to this `DocumentReference`<!-- -->, allowing yo
103103
<b>Signature:</b>
104104

105105
```typescript
106-
withConverter<U>(converter: FirestoreDataConverter<U>): DocumentReference<U>;
106+
withConverter<NewAppType = DocumentData, NewDbType extends DocumentData = NewAppType extends DocumentData ? NewAppType : DocumentData>(converter: FirestoreDataConverter<NewAppType, NewDbType>): DocumentReference<NewAppType, NewDbType>;
107107
```
108108

109109
### Parameters
110110

111111
| Parameter | Type | Description |
112112
| --- | --- | --- |
113-
| converter | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;U&gt; | Converts objects to and from Firestore. |
113+
| converter | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;NewAppType, NewDbType&gt; | Converts objects to and from Firestore. |
114114

115115
<b>Returns:</b>
116116

117-
[DocumentReference](./firestore_.documentreference.md#documentreference_class)<!-- -->&lt;U&gt;
117+
[DocumentReference](./firestore_.documentreference.md#documentreference_class)<!-- -->&lt;NewAppType, NewDbType&gt;
118118

119119
A `DocumentReference<U>` that uses the provided converter.
120120

@@ -125,7 +125,7 @@ Removes the current converter.
125125
<b>Signature:</b>
126126

127127
```typescript
128-
withConverter(converter: null): DocumentReference<DocumentData>;
128+
withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
129129
```
130130

131131
### Parameters
@@ -136,7 +136,7 @@ withConverter(converter: null): DocumentReference<DocumentData>;
136136

137137
<b>Returns:</b>
138138

139-
[DocumentReference](./firestore_.documentreference.md#documentreference_class)<!-- -->&lt;[DocumentData](./firestore_.documentdata.md#documentdata_interface)<!-- -->&gt;
139+
[DocumentReference](./firestore_.documentreference.md#documentreference_class)<!-- -->&lt;[DocumentData](./firestore_.md#documentdata)<!-- -->, [DocumentData](./firestore_.md#documentdata)<!-- -->&gt;
140140

141141
A `DocumentReference<DocumentData>` that does not use a converter.
142142

docs-devsite/firestore_.documentsnapshot.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ For a `DocumentSnapshot` that points to a non-existing document, any data access
1717
<b>Signature:</b>
1818

1919
```typescript
20-
export declare class DocumentSnapshot<T = DocumentData>
20+
export declare class DocumentSnapshot<AppType = DocumentData, DbType extends DocumentData = AppType extends DocumentData ? AppType : DocumentData>
2121
```
2222

2323
## Constructors
@@ -32,7 +32,7 @@ export declare class DocumentSnapshot<T = DocumentData>
3232
| --- | --- | --- | --- |
3333
| [id](./firestore_.documentsnapshot.md#documentsnapshotid) | | string | Property of the <code>DocumentSnapshot</code> that provides the document's ID. |
3434
| [metadata](./firestore_.documentsnapshot.md#documentsnapshotmetadata) | | [SnapshotMetadata](./firestore_.snapshotmetadata.md#snapshotmetadata_class) | Metadata about the <code>DocumentSnapshot</code>, including information about its source and local modifications. |
35-
| [ref](./firestore_.documentsnapshot.md#documentsnapshotref) | | [DocumentReference](./firestore_.documentreference.md#documentreference_class)<!-- -->&lt;T&gt; | The <code>DocumentReference</code> for the document included in the <code>DocumentSnapshot</code>. |
35+
| [ref](./firestore_.documentsnapshot.md#documentsnapshotref) | | [DocumentReference](./firestore_.documentreference.md#documentreference_class)<!-- -->&lt;AppType, DbType&gt; | The <code>DocumentReference</code> for the document included in the <code>DocumentSnapshot</code>. |
3636

3737
## Methods
3838

@@ -79,7 +79,7 @@ The `DocumentReference` for the document included in the `DocumentSnapshot`<!--
7979
<b>Signature:</b>
8080

8181
```typescript
82-
get ref(): DocumentReference<T>;
82+
get ref(): DocumentReference<AppType, DbType>;
8383
```
8484

8585
## DocumentSnapshot.data()
@@ -91,7 +91,7 @@ By default, `serverTimestamp()` values that have not yet been set to their final
9191
<b>Signature:</b>
9292

9393
```typescript
94-
data(options?: SnapshotOptions): T | undefined;
94+
data(options?: SnapshotOptions): AppType | undefined;
9595
```
9696

9797
### Parameters
@@ -102,7 +102,7 @@ data(options?: SnapshotOptions): T | undefined;
102102

103103
<b>Returns:</b>
104104

105-
T \| undefined
105+
AppType \| undefined
106106

107107
An `Object` containing all fields in the document or `undefined` if the document doesn't exist.
108108

@@ -113,11 +113,11 @@ Returns whether or not the data exists. True if the document exists.
113113
<b>Signature:</b>
114114

115115
```typescript
116-
exists(): this is QueryDocumentSnapshot<T>;
116+
exists(): this is QueryDocumentSnapshot<AppType, DbType>;
117117
```
118118
<b>Returns:</b>
119119

120-
this is [QueryDocumentSnapshot](./firestore_.querydocumentsnapshot.md#querydocumentsnapshot_class)<!-- -->&lt;T&gt;
120+
this is [QueryDocumentSnapshot](./firestore_.querydocumentsnapshot.md#querydocumentsnapshot_class)<!-- -->&lt;AppType, DbType&gt;
121121

122122
## DocumentSnapshot.get()
123123

0 commit comments

Comments
 (0)