Skip to content

Commit edc1ea5

Browse files
MarkDuckworthMarkDuckworth
committed
Docgen
1 parent 9a1ffa6 commit edc1ea5

File tree

256 files changed

+60953
-3542
lines changed

Some content is hidden

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

256 files changed

+60953
-3542
lines changed

‎docs-devsite/_toc.yaml

Lines changed: 410 additions & 73 deletions
Large diffs are not rendered by default.

‎docs-devsite/firestore_.accumulator.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# Accumulator interface
13+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
14+
>
15+
16+
An interface that represents an accumulator.
17+
18+
<b>Signature:</b>
19+
20+
```typescript
21+
export declare interface Accumulator
22+
```
23+
24+
## Properties
25+
26+
| Property | Type | Description |
27+
| --- | --- | --- |
28+
| [accumulator](./firestore_.accumulator.md#accumulatoraccumulator) | true | <b><i>(BETA)</i></b> |
29+
30+
## Accumulator.accumulator
31+
32+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
33+
>
34+
35+
<b>Signature:</b>
36+
37+
```typescript
38+
accumulator: true;
39+
```

‎docs-devsite/firestore_.add.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# Add class
13+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
14+
>
15+
16+
17+
<b>Signature:</b>
18+
19+
```typescript
20+
export declare class Add extends FirestoreFunction
21+
```
22+
<b>Extends:</b> [FirestoreFunction](./firestore_.firestorefunction.md#firestorefunction_class)
23+
24+
## Constructors
25+
26+
| Constructor | Modifiers | Description |
27+
| --- | --- | --- |
28+
| [(constructor)(left, right)](./firestore_.add.md#addconstructor) | | <b><i>(BETA)</i></b> Constructs a new instance of the <code>Add</code> class |
29+
30+
## Add.(constructor)
31+
32+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
33+
>
34+
35+
Constructs a new instance of the `Add` class
36+
37+
<b>Signature:</b>
38+
39+
```typescript
40+
constructor(left: Constant, right: Constant);
41+
```
42+
43+
#### Parameters
44+
45+
| Parameter | Type | Description |
46+
| --- | --- | --- |
47+
| left | [Constant](./firestore_.constant.md#constant_class) | |
48+
| right | [Constant](./firestore_.constant.md#constant_class) | |
49+

‎docs-devsite/firestore_.addfields.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# AddFields class
13+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
14+
>
15+
16+
17+
<b>Signature:</b>
18+
19+
```typescript
20+
export declare class AddFields implements Stage
21+
```
22+
<b>Implements:</b> [Stage](./firestore_.stage.md#stage_interface)
23+
24+
## Constructors
25+
26+
| Constructor | Modifiers | Description |
27+
| --- | --- | --- |
28+
| [(constructor)(fields)](./firestore_.addfields.md#addfieldsconstructor) | | <b><i>(BETA)</i></b> Constructs a new instance of the <code>AddFields</code> class |
29+
30+
## Properties
31+
32+
| Property | Modifiers | Type | Description |
33+
| --- | --- | --- | --- |
34+
| [name](./firestore_.addfields.md#addfieldsname) | | string | <b><i>(BETA)</i></b> |
35+
36+
## AddFields.(constructor)
37+
38+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
39+
>
40+
41+
Constructs a new instance of the `AddFields` class
42+
43+
<b>Signature:</b>
44+
45+
```typescript
46+
constructor(fields: Map<string, Constant>);
47+
```
48+
49+
#### Parameters
50+
51+
| Parameter | Type | Description |
52+
| --- | --- | --- |
53+
| fields | Map&lt;string, [Constant](./firestore_.constant.md#constant_class)<!-- -->&gt; | |
54+
55+
## AddFields.name
56+
57+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
58+
>
59+
60+
<b>Signature:</b>
61+
62+
```typescript
63+
name: string;
64+
```

‎docs-devsite/firestore_.aggregate.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# Aggregate class
13+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
14+
>
15+
16+
17+
<b>Signature:</b>
18+
19+
```typescript
20+
export declare class Aggregate implements Stage
21+
```
22+
<b>Implements:</b> [Stage](./firestore_.stage.md#stage_interface)
23+
24+
## Constructors
25+
26+
| Constructor | Modifiers | Description |
27+
| --- | --- | --- |
28+
| [(constructor)(accumulators, groups)](./firestore_.aggregate.md#aggregateconstructor) | | <b><i>(BETA)</i></b> Constructs a new instance of the <code>Aggregate</code> class |
29+
30+
## Properties
31+
32+
| Property | Modifiers | Type | Description |
33+
| --- | --- | --- | --- |
34+
| [name](./firestore_.aggregate.md#aggregatename) | | string | <b><i>(BETA)</i></b> |
35+
36+
## Aggregate.(constructor)
37+
38+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
39+
>
40+
41+
Constructs a new instance of the `Aggregate` class
42+
43+
<b>Signature:</b>
44+
45+
```typescript
46+
constructor(accumulators: Map<string, Accumulator>, groups: Map<string, Constant>);
47+
```
48+
49+
#### Parameters
50+
51+
| Parameter | Type | Description |
52+
| --- | --- | --- |
53+
| accumulators | Map&lt;string, [Accumulator](./firestore_.accumulator.md#accumulator_interface)<!-- -->&gt; | |
54+
| groups | Map&lt;string, [Constant](./firestore_.constant.md#constant_class)<!-- -->&gt; | |
55+
56+
## Aggregate.name
57+
58+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
59+
>
60+
61+
<b>Signature:</b>
62+
63+
```typescript
64+
name: string;
65+
```

‎docs-devsite/firestore_.and.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# and namespace
13+
<b>Signature:</b>
14+
15+
```typescript
16+
export declare namespace and
17+
```

‎docs-devsite/firestore_.arrayconcat.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# ArrayConcat class
13+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
14+
>
15+
16+
17+
<b>Signature:</b>
18+
19+
```typescript
20+
export declare class ArrayConcat extends FirestoreFunction
21+
```
22+
<b>Extends:</b> [FirestoreFunction](./firestore_.firestorefunction.md#firestorefunction_class)
23+
24+
## Constructors
25+
26+
| Constructor | Modifiers | Description |
27+
| --- | --- | --- |
28+
| [(constructor)(array, elements)](./firestore_.arrayconcat.md#arrayconcatconstructor) | | <b><i>(BETA)</i></b> Constructs a new instance of the <code>ArrayConcat</code> class |
29+
30+
## ArrayConcat.(constructor)
31+
32+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
33+
>
34+
35+
Constructs a new instance of the `ArrayConcat` class
36+
37+
<b>Signature:</b>
38+
39+
```typescript
40+
constructor(array: Constant, elements: Constant[]);
41+
```
42+
43+
#### Parameters
44+
45+
| Parameter | Type | Description |
46+
| --- | --- | --- |
47+
| array | [Constant](./firestore_.constant.md#constant_class) | |
48+
| elements | [Constant](./firestore_.constant.md#constant_class)<!-- -->\[\] | |
49+

‎docs-devsite/firestore_.arraycontains.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# ArrayContains class
13+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
14+
>
15+
16+
17+
<b>Signature:</b>
18+
19+
```typescript
20+
export declare class ArrayContains extends FirestoreFunction implements FilterCondition
21+
```
22+
<b>Extends:</b> [FirestoreFunction](./firestore_.firestorefunction.md#firestorefunction_class)
23+
24+
<b>Implements:</b> [FilterCondition](./firestore_.filtercondition.md#filtercondition_interface)
25+
26+
## Constructors
27+
28+
| Constructor | Modifiers | Description |
29+
| --- | --- | --- |
30+
| [(constructor)(array, element)](./firestore_.arraycontains.md#arraycontainsconstructor) | | <b><i>(BETA)</i></b> Constructs a new instance of the <code>ArrayContains</code> class |
31+
32+
## Properties
33+
34+
| Property | Modifiers | Type | Description |
35+
| --- | --- | --- | --- |
36+
| [filterable](./firestore_.arraycontains.md#arraycontainsfilterable) | | true | <b><i>(BETA)</i></b> |
37+
38+
## ArrayContains.(constructor)
39+
40+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
41+
>
42+
43+
Constructs a new instance of the `ArrayContains` class
44+
45+
<b>Signature:</b>
46+
47+
```typescript
48+
constructor(array: Constant, element: Constant);
49+
```
50+
51+
#### Parameters
52+
53+
| Parameter | Type | Description |
54+
| --- | --- | --- |
55+
| array | [Constant](./firestore_.constant.md#constant_class) | |
56+
| element | [Constant](./firestore_.constant.md#constant_class) | |
57+
58+
## ArrayContains.filterable
59+
60+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
61+
>
62+
63+
<b>Signature:</b>
64+
65+
```typescript
66+
filterable: true;
67+
```

0 commit comments

Comments
 (0)