Skip to content

Commit c211ea2

Browse files
DellaBittaDellaBitta
committed
Docgen
1 parent 4c8e431 commit c211ea2

8 files changed

+64
-32
lines changed

‎docs-devsite/firestore_.bytes.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export declare class Bytes
2323
| Method | Modifiers | Description |
2424
| --- | --- | --- |
2525
| [fromBase64String(base64)](./firestore_.bytes.md#bytesfrombase64string) | <code>static</code> | Creates a new <code>Bytes</code> object from the given Base64 string, converting it to bytes. |
26-
| [fromJSON(json)](./firestore_.bytes.md#bytesfromjson) | <code>static</code> | Builds a <code>Bytes</code> instance from a JSON serialized version of <code>Bytes</code>. |
26+
| [fromJSON(json)](./firestore_.bytes.md#bytesfromjson) | <code>static</code> | Builds a <code>Byes</code> instance from a JSON object created by [Bytes.toJSON()](./firestore_.bytes.md#bytestojson)<!-- -->. |
2727
| [fromUint8Array(array)](./firestore_.bytes.md#bytesfromuint8array) | <code>static</code> | Creates a new <code>Bytes</code> object from the given Uint8Array. |
2828
| [isEqual(other)](./firestore_.bytes.md#bytesisequal) | | Returns true if this <code>Bytes</code> object is equal to the provided one. |
2929
| [toBase64()](./firestore_.bytes.md#bytestobase64) | | Returns the underlying bytes as a Base64-encoded string. |
@@ -53,7 +53,7 @@ static fromBase64String(base64: string): Bytes;
5353

5454
## Bytes.fromJSON()
5555

56-
Builds a `Bytes` instance from a JSON serialized version of `Bytes`<!-- -->.
56+
Builds a `Byes` instance from a JSON object created by [Bytes.toJSON()](./firestore_.bytes.md#bytestojson)<!-- -->.
5757

5858
<b>Signature:</b>
5959

@@ -65,12 +65,14 @@ static fromJSON(json: object): Bytes;
6565

6666
| Parameter | Type | Description |
6767
| --- | --- | --- |
68-
| json | object | |
68+
| json | object | a JSON object represention of a <code>Bytes</code> instance |
6969

7070
<b>Returns:</b>
7171

7272
[Bytes](./firestore_.bytes.md#bytes_class)
7373

74+
an instance of [Bytes](./firestore_.bytes.md#bytes_class) if the JSON object could be parsed. Throws a [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class) if an error occurs.
75+
7476
## Bytes.fromUint8Array()
7577

7678
Creates a new `Bytes` object from the given Uint8Array.
@@ -141,6 +143,8 @@ toJSON(): object;
141143

142144
object
143145

146+
a JSON representation of this object.
147+
144148
## Bytes.toString()
145149

146150
Returns a string representation of the `Bytes` object.

‎docs-devsite/firestore_.documentreference.md‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ export declare class DocumentReference<AppModelType = DocumentData, DbModelType
3333

3434
| Method | Modifiers | Description |
3535
| --- | --- | --- |
36-
| [fromJSON(firestore, json, converter)](./firestore_.documentreference.md#documentreferencefromjson) | <code>static</code> | Builds a <code>DocumentReference</code> instance from a JSON serialized version of <code>DocumentReference</code>. |
37-
| [toJSON()](./firestore_.documentreference.md#documentreferencetojson) | | Returns a JSON-serializable representation of this DocumentReference. |
36+
| [fromJSON(firestore, json, converter)](./firestore_.documentreference.md#documentreferencefromjson) | <code>static</code> | Builds a <code>DocumentReference</code> instance from a JSON object created by [DocumentReference.toJSON()](./firestore_.documentreference.md#documentreferencetojson)<!-- -->. |
37+
| [toJSON()](./firestore_.documentreference.md#documentreferencetojson) | | Returns a JSON-serializable representation of this <code>DocumentReference</code> instance. |
3838
| [withConverter(converter)](./firestore_.documentreference.md#documentreferencewithconverter) | | Applies a custom data converter to this <code>DocumentReference</code>, allowing you to use your own custom model objects with Firestore. When you call [setDoc()](./firestore_lite.md#setdoc_ee215ad)<!-- -->, [getDoc()](./firestore_lite.md#getdoc_4569087)<!-- -->, etc. with the returned <code>DocumentReference</code> instance, the provided converter will convert between Firestore data of type <code>NewDbModelType</code> and your custom type <code>NewAppModelType</code>. |
3939
| [withConverter(converter)](./firestore_.documentreference.md#documentreferencewithconverter) | | Removes the current converter. |
4040

@@ -100,7 +100,7 @@ readonly type = "document";
100100

101101
## DocumentReference.fromJSON()
102102

103-
Builds a `DocumentReference` instance from a JSON serialized version of `DocumentReference`<!-- -->.
103+
Builds a `DocumentReference` instance from a JSON object created by [DocumentReference.toJSON()](./firestore_.documentreference.md#documentreferencetojson)<!-- -->.
104104

105105
<b>Signature:</b>
106106

@@ -113,16 +113,18 @@ static fromJSON<NewAppModelType = DocumentData, NewDbModelType extends DocumentD
113113
| Parameter | Type | Description |
114114
| --- | --- | --- |
115115
| firestore | [Firestore](./firestore_.firestore.md#firestore_class) | |
116-
| json | object | |
116+
| json | object | a JSON object represention of a <code>DocumentReference</code> instance |
117117
| converter | [FirestoreDataConverter](./firestore_.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;NewAppModelType, NewDbModelType&gt; | |
118118

119119
<b>Returns:</b>
120120

121121
[DocumentReference](./firestore_.documentreference.md#documentreference_class)<!-- -->&lt;NewAppModelType, NewDbModelType&gt;
122122

123+
an instance of [DocumentReference](./firestore_.documentreference.md#documentreference_class) if the JSON object could be parsed. Throws a [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class) if an error occurs.
124+
123125
## DocumentReference.toJSON()
124126

125-
Returns a JSON-serializable representation of this DocumentReference.
127+
Returns a JSON-serializable representation of this `DocumentReference` instance.
126128

127129
<b>Signature:</b>
128130

@@ -133,6 +135,8 @@ toJSON(): object;
133135

134136
object
135137

138+
a JSON representation of this object.
139+
136140
## DocumentReference.withConverter()
137141

138142
Applies a custom data converter to this `DocumentReference`<!-- -->, allowing you to use your own custom model objects with Firestore. When you call [setDoc()](./firestore_lite.md#setdoc_ee215ad)<!-- -->, [getDoc()](./firestore_lite.md#getdoc_4569087)<!-- -->, etc. with the returned `DocumentReference` instance, the provided converter will convert between Firestore data of type `NewDbModelType` and your custom type `NewAppModelType`<!-- -->.

‎docs-devsite/firestore_.geopoint.md‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ export declare class GeoPoint
3737

3838
| Method | Modifiers | Description |
3939
| --- | --- | --- |
40-
| [fromJSON(json)](./firestore_.geopoint.md#geopointfromjson) | <code>static</code> | Builds a <code>Timestamp</code> instance from a JSON serialized version of <code>Bytes</code>. |
40+
| [fromJSON(json)](./firestore_.geopoint.md#geopointfromjson) | <code>static</code> | Builds a <code>GeoPoint</code> instance from a JSON object created by [GeoPoint.toJSON()](./firestore_.geopoint.md#geopointtojson)<!-- -->. |
4141
| [isEqual(other)](./firestore_.geopoint.md#geopointisequal) | | Returns true if this <code>GeoPoint</code> is equal to the provided one. |
42-
| [toJSON()](./firestore_.geopoint.md#geopointtojson) | | Returns a JSON-serializable representation of this GeoPoint. |
42+
| [toJSON()](./firestore_.geopoint.md#geopointtojson) | | Returns a JSON-serializable representation of this <code>GeoPoint</code> instance. |
4343

4444
## GeoPoint.(constructor)
4545

@@ -80,7 +80,7 @@ get longitude(): number;
8080

8181
## GeoPoint.fromJSON()
8282

83-
Builds a `Timestamp` instance from a JSON serialized version of `Bytes`<!-- -->.
83+
Builds a `GeoPoint` instance from a JSON object created by [GeoPoint.toJSON()](./firestore_.geopoint.md#geopointtojson)<!-- -->.
8484

8585
<b>Signature:</b>
8686

@@ -92,12 +92,14 @@ static fromJSON(json: object): GeoPoint;
9292

9393
| Parameter | Type | Description |
9494
| --- | --- | --- |
95-
| json | object | |
95+
| json | object | a JSON object represention of a <code>GeoPoint</code> instance |
9696

9797
<b>Returns:</b>
9898

9999
[GeoPoint](./firestore_.geopoint.md#geopoint_class)
100100

101+
an instance of [GeoPoint](./firestore_.geopoint.md#geopoint_class) if the JSON object could be parsed. Throws a [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class) if an error occurs.
102+
101103
## GeoPoint.isEqual()
102104

103105
Returns true if this `GeoPoint` is equal to the provided one.
@@ -122,7 +124,7 @@ true if this `GeoPoint` is equal to the provided one.
122124

123125
## GeoPoint.toJSON()
124126

125-
Returns a JSON-serializable representation of this GeoPoint.
127+
Returns a JSON-serializable representation of this `GeoPoint` instance.
126128

127129
<b>Signature:</b>
128130

@@ -137,3 +139,5 @@ toJSON(): {
137139

138140
{ latitude: number; longitude: number; type: string; }
139141

142+
a JSON representation of this object.
143+

‎docs-devsite/firestore_.vectorvalue.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ export declare class VectorValue
2424

2525
| Method | Modifiers | Description |
2626
| --- | --- | --- |
27-
| [fromJSON(json)](./firestore_.vectorvalue.md#vectorvaluefromjson) | <code>static</code> | Builds a <code>Bytes</code> instance from a JSON serialized version of <code>Bytes</code>. |
27+
| [fromJSON(json)](./firestore_.vectorvalue.md#vectorvaluefromjson) | <code>static</code> | Builds a <code>VectorValue</code> instance from a JSON object created by [VectorValue.toJSON()](./firestore_.vectorvalue.md#vectorvaluetojson)<!-- -->. |
2828
| [isEqual(other)](./firestore_.vectorvalue.md#vectorvalueisequal) | | Returns <code>true</code> if the two <code>VectorValue</code> values have the same raw number arrays, returns <code>false</code> otherwise. |
2929
| [toArray()](./firestore_.vectorvalue.md#vectorvaluetoarray) | | Returns a copy of the raw number array form of the vector. |
3030
| [toJSON()](./firestore_.vectorvalue.md#vectorvaluetojson) | | Returns a JSON-serializable representation of this <code>VectorValue</code> instance. |
3131

3232
## VectorValue.fromJSON()
3333

34-
Builds a `Bytes` instance from a JSON serialized version of `Bytes`<!-- -->.
34+
Builds a `VectorValue` instance from a JSON object created by [VectorValue.toJSON()](./firestore_.vectorvalue.md#vectorvaluetojson)<!-- -->.
3535

3636
<b>Signature:</b>
3737

@@ -43,12 +43,14 @@ static fromJSON(json: object): VectorValue;
4343

4444
| Parameter | Type | Description |
4545
| --- | --- | --- |
46-
| json | object | |
46+
| json | object | a JSON object represention of a <code>VectorValue</code> instance |
4747

4848
<b>Returns:</b>
4949

5050
[VectorValue](./firestore_.vectorvalue.md#vectorvalue_class)
5151

52+
an instance of [VectorValue](./firestore_.vectorvalue.md#vectorvalue_class) if the JSON object could be parsed. Throws a [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class) if an error occurs.
53+
5254
## VectorValue.isEqual()
5355

5456
Returns `true` if the two `VectorValue` values have the same raw number arrays, returns `false` otherwise.
@@ -95,3 +97,5 @@ toJSON(): object;
9597

9698
object
9799

100+
a JSON representation of this object.
101+

‎docs-devsite/firestore_lite.bytes.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export declare class Bytes
2323
| Method | Modifiers | Description |
2424
| --- | --- | --- |
2525
| [fromBase64String(base64)](./firestore_lite.bytes.md#bytesfrombase64string) | <code>static</code> | Creates a new <code>Bytes</code> object from the given Base64 string, converting it to bytes. |
26-
| [fromJSON(json)](./firestore_lite.bytes.md#bytesfromjson) | <code>static</code> | Builds a <code>Bytes</code> instance from a JSON serialized version of <code>Bytes</code>. |
26+
| [fromJSON(json)](./firestore_lite.bytes.md#bytesfromjson) | <code>static</code> | Builds a <code>Byes</code> instance from a JSON object created by [Bytes.toJSON()](./firestore_.bytes.md#bytestojson)<!-- -->. |
2727
| [fromUint8Array(array)](./firestore_lite.bytes.md#bytesfromuint8array) | <code>static</code> | Creates a new <code>Bytes</code> object from the given Uint8Array. |
2828
| [isEqual(other)](./firestore_lite.bytes.md#bytesisequal) | | Returns true if this <code>Bytes</code> object is equal to the provided one. |
2929
| [toBase64()](./firestore_lite.bytes.md#bytestobase64) | | Returns the underlying bytes as a Base64-encoded string. |
@@ -53,7 +53,7 @@ static fromBase64String(base64: string): Bytes;
5353

5454
## Bytes.fromJSON()
5555

56-
Builds a `Bytes` instance from a JSON serialized version of `Bytes`<!-- -->.
56+
Builds a `Byes` instance from a JSON object created by [Bytes.toJSON()](./firestore_.bytes.md#bytestojson)<!-- -->.
5757

5858
<b>Signature:</b>
5959

@@ -65,12 +65,14 @@ static fromJSON(json: object): Bytes;
6565

6666
| Parameter | Type | Description |
6767
| --- | --- | --- |
68-
| json | object | |
68+
| json | object | a JSON object represention of a <code>Bytes</code> instance |
6969

7070
<b>Returns:</b>
7171

7272
[Bytes](./firestore_lite.bytes.md#bytes_class)
7373

74+
an instance of [Bytes](./firestore_.bytes.md#bytes_class) if the JSON object could be parsed. Throws a [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class) if an error occurs.
75+
7476
## Bytes.fromUint8Array()
7577

7678
Creates a new `Bytes` object from the given Uint8Array.
@@ -141,6 +143,8 @@ toJSON(): object;
141143

142144
object
143145

146+
a JSON representation of this object.
147+
144148
## Bytes.toString()
145149

146150
Returns a string representation of the `Bytes` object.

‎docs-devsite/firestore_lite.documentreference.md‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ export declare class DocumentReference<AppModelType = DocumentData, DbModelType
3333

3434
| Method | Modifiers | Description |
3535
| --- | --- | --- |
36-
| [fromJSON(firestore, json, converter)](./firestore_lite.documentreference.md#documentreferencefromjson) | <code>static</code> | Builds a <code>DocumentReference</code> instance from a JSON serialized version of <code>DocumentReference</code>. |
37-
| [toJSON()](./firestore_lite.documentreference.md#documentreferencetojson) | | Returns a JSON-serializable representation of this DocumentReference. |
36+
| [fromJSON(firestore, json, converter)](./firestore_lite.documentreference.md#documentreferencefromjson) | <code>static</code> | Builds a <code>DocumentReference</code> instance from a JSON object created by [DocumentReference.toJSON()](./firestore_.documentreference.md#documentreferencetojson)<!-- -->. |
37+
| [toJSON()](./firestore_lite.documentreference.md#documentreferencetojson) | | Returns a JSON-serializable representation of this <code>DocumentReference</code> instance. |
3838
| [withConverter(converter)](./firestore_lite.documentreference.md#documentreferencewithconverter) | | Applies a custom data converter to this <code>DocumentReference</code>, allowing you to use your own custom model objects with Firestore. When you call [setDoc()](./firestore_lite.md#setdoc_ee215ad)<!-- -->, [getDoc()](./firestore_lite.md#getdoc_4569087)<!-- -->, etc. with the returned <code>DocumentReference</code> instance, the provided converter will convert between Firestore data of type <code>NewDbModelType</code> and your custom type <code>NewAppModelType</code>. |
3939
| [withConverter(converter)](./firestore_lite.documentreference.md#documentreferencewithconverter) | | Removes the current converter. |
4040

@@ -100,7 +100,7 @@ readonly type = "document";
100100

101101
## DocumentReference.fromJSON()
102102

103-
Builds a `DocumentReference` instance from a JSON serialized version of `DocumentReference`<!-- -->.
103+
Builds a `DocumentReference` instance from a JSON object created by [DocumentReference.toJSON()](./firestore_.documentreference.md#documentreferencetojson)<!-- -->.
104104

105105
<b>Signature:</b>
106106

@@ -113,16 +113,18 @@ static fromJSON<NewAppModelType = DocumentData, NewDbModelType extends DocumentD
113113
| Parameter | Type | Description |
114114
| --- | --- | --- |
115115
| firestore | [Firestore](./firestore_lite.firestore.md#firestore_class) | |
116-
| json | object | |
116+
| json | object | a JSON object represention of a <code>DocumentReference</code> instance |
117117
| converter | [FirestoreDataConverter](./firestore_lite.firestoredataconverter.md#firestoredataconverter_interface)<!-- -->&lt;NewAppModelType, NewDbModelType&gt; | |
118118

119119
<b>Returns:</b>
120120

121121
[DocumentReference](./firestore_lite.documentreference.md#documentreference_class)<!-- -->&lt;NewAppModelType, NewDbModelType&gt;
122122

123+
an instance of [DocumentReference](./firestore_.documentreference.md#documentreference_class) if the JSON object could be parsed. Throws a [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class) if an error occurs.
124+
123125
## DocumentReference.toJSON()
124126

125-
Returns a JSON-serializable representation of this DocumentReference.
127+
Returns a JSON-serializable representation of this `DocumentReference` instance.
126128

127129
<b>Signature:</b>
128130

@@ -133,6 +135,8 @@ toJSON(): object;
133135

134136
object
135137

138+
a JSON representation of this object.
139+
136140
## DocumentReference.withConverter()
137141

138142
Applies a custom data converter to this `DocumentReference`<!-- -->, allowing you to use your own custom model objects with Firestore. When you call [setDoc()](./firestore_lite.md#setdoc_ee215ad)<!-- -->, [getDoc()](./firestore_lite.md#getdoc_4569087)<!-- -->, etc. with the returned `DocumentReference` instance, the provided converter will convert between Firestore data of type `NewDbModelType` and your custom type `NewAppModelType`<!-- -->.

‎docs-devsite/firestore_lite.geopoint.md‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ export declare class GeoPoint
3737

3838
| Method | Modifiers | Description |
3939
| --- | --- | --- |
40-
| [fromJSON(json)](./firestore_lite.geopoint.md#geopointfromjson) | <code>static</code> | Builds a <code>Timestamp</code> instance from a JSON serialized version of <code>Bytes</code>. |
40+
| [fromJSON(json)](./firestore_lite.geopoint.md#geopointfromjson) | <code>static</code> | Builds a <code>GeoPoint</code> instance from a JSON object created by [GeoPoint.toJSON()](./firestore_.geopoint.md#geopointtojson)<!-- -->. |
4141
| [isEqual(other)](./firestore_lite.geopoint.md#geopointisequal) | | Returns true if this <code>GeoPoint</code> is equal to the provided one. |
42-
| [toJSON()](./firestore_lite.geopoint.md#geopointtojson) | | Returns a JSON-serializable representation of this GeoPoint. |
42+
| [toJSON()](./firestore_lite.geopoint.md#geopointtojson) | | Returns a JSON-serializable representation of this <code>GeoPoint</code> instance. |
4343

4444
## GeoPoint.(constructor)
4545

@@ -80,7 +80,7 @@ get longitude(): number;
8080

8181
## GeoPoint.fromJSON()
8282

83-
Builds a `Timestamp` instance from a JSON serialized version of `Bytes`<!-- -->.
83+
Builds a `GeoPoint` instance from a JSON object created by [GeoPoint.toJSON()](./firestore_.geopoint.md#geopointtojson)<!-- -->.
8484

8585
<b>Signature:</b>
8686

@@ -92,12 +92,14 @@ static fromJSON(json: object): GeoPoint;
9292

9393
| Parameter | Type | Description |
9494
| --- | --- | --- |
95-
| json | object | |
95+
| json | object | a JSON object represention of a <code>GeoPoint</code> instance |
9696

9797
<b>Returns:</b>
9898

9999
[GeoPoint](./firestore_lite.geopoint.md#geopoint_class)
100100

101+
an instance of [GeoPoint](./firestore_.geopoint.md#geopoint_class) if the JSON object could be parsed. Throws a [FirestoreError](./firestore_.firestoreerror.md#firestoreerror_class) if an error occurs.
102+
101103
## GeoPoint.isEqual()
102104

103105
Returns true if this `GeoPoint` is equal to the provided one.
@@ -122,7 +124,7 @@ true if this `GeoPoint` is equal to the provided one.
122124

123125
## GeoPoint.toJSON()
124126

125-
Returns a JSON-serializable representation of this GeoPoint.
127+
Returns a JSON-serializable representation of this `GeoPoint` instance.
126128

127129
<b>Signature:</b>
128130

@@ -137,3 +139,5 @@ toJSON(): {
137139

138140
{ latitude: number; longitude: number; type: string; }
139141

142+
a JSON representation of this object.
143+

0 commit comments

Comments
 (0)