Skip to content

Commit 7d946ce

Browse files
wu-huiwu-hui
committed
feat(firestore): remove beta tags for pipelines.
1 parent f87c15e commit 7d946ce

44 files changed

Lines changed: 2521 additions & 6575 deletions

File tree

Some content is hidden

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

‎common/api-review/firestore-lite-pipelines.api.md‎

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

‎common/api-review/firestore-pipelines.api.md‎

Lines changed: 386 additions & 406 deletions
Large diffs are not rendered by default.

‎docs-devsite/firestore_lite_pipelines.aggregatefunction.md‎

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# AggregateFunction 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-
1613
A class that represents an aggregate function.
1714

1815
<b>Signature:</b>
@@ -25,25 +22,22 @@ export declare class AggregateFunction
2522

2623
| Constructor | Modifiers | Description |
2724
| --- | --- | --- |
28-
| [(constructor)(name, params)](./firestore_lite_pipelines.aggregatefunction.md#aggregatefunctionconstructor) | | <b><i>(Public Preview)</i></b> Constructs a new instance of the <code>AggregateFunction</code> class |
25+
| [(constructor)(name, params)](./firestore_lite_pipelines.aggregatefunction.md#aggregatefunctionconstructor) | | Constructs a new instance of the <code>AggregateFunction</code> class |
2926

3027
## Properties
3128

3229
| Property | Modifiers | Type | Description |
3330
| --- | --- | --- | --- |
34-
| [exprType](./firestore_lite_pipelines.aggregatefunction.md#aggregatefunctionexprtype) | | [ExpressionType](./firestore_lite_pipelines.md#expressiontype) | <b><i>(Public Preview)</i></b> |
31+
| [exprType](./firestore_lite_pipelines.aggregatefunction.md#aggregatefunctionexprtype) | | [ExpressionType](./firestore_lite_pipelines.md#expressiontype) | |
3532

3633
## Methods
3734

3835
| Method | Modifiers | Description |
3936
| --- | --- | --- |
40-
| [as(name)](./firestore_lite_pipelines.aggregatefunction.md#aggregatefunctionas) | | <b><i>(Public Preview)</i></b> Assigns an alias to this AggregateFunction. The alias specifies the name that the aggregated value will have in the output document. |
37+
| [as(name)](./firestore_lite_pipelines.aggregatefunction.md#aggregatefunctionas) | | Assigns an alias to this AggregateFunction. The alias specifies the name that the aggregated value will have in the output document. |
4138

4239
## AggregateFunction.(constructor)
4340

44-
> 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.
45-
>
46-
4741
Constructs a new instance of the `AggregateFunction` class
4842

4943
<b>Signature:</b>
@@ -61,9 +55,6 @@ constructor(name: string, params: Expression[]);
6155

6256
## AggregateFunction.exprType
6357

64-
> 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.
65-
>
66-
6758
<b>Signature:</b>
6859

6960
```typescript
@@ -72,9 +63,6 @@ exprType: ExpressionType;
7263

7364
## AggregateFunction.as()
7465

75-
> 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.
76-
>
77-
7866
Assigns an alias to this AggregateFunction. The alias specifies the name that the aggregated value will have in the output document.
7967

8068
<b>Signature:</b>

‎docs-devsite/firestore_lite_pipelines.aliasedaggregate.md‎

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# AliasedAggregate 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-
1613
An AggregateFunction with alias.
1714

1815
<b>Signature:</b>
@@ -25,20 +22,17 @@ export declare class AliasedAggregate
2522

2623
| Constructor | Modifiers | Description |
2724
| --- | --- | --- |
28-
| [(constructor)(aggregate, alias, \_methodName)](./firestore_lite_pipelines.aliasedaggregate.md#aliasedaggregateconstructor) | | <b><i>(Public Preview)</i></b> Constructs a new instance of the <code>AliasedAggregate</code> class |
25+
| [(constructor)(aggregate, alias, \_methodName)](./firestore_lite_pipelines.aliasedaggregate.md#aliasedaggregateconstructor) | | Constructs a new instance of the <code>AliasedAggregate</code> class |
2926

3027
## Properties
3128

3229
| Property | Modifiers | Type | Description |
3330
| --- | --- | --- | --- |
34-
| [aggregate](./firestore_lite_pipelines.aliasedaggregate.md#aliasedaggregateaggregate) | | [AggregateFunction](./firestore_lite_pipelines.aggregatefunction.md#aggregatefunction_class) | <b><i>(Public Preview)</i></b> |
35-
| [alias](./firestore_lite_pipelines.aliasedaggregate.md#aliasedaggregatealias) | | string | <b><i>(Public Preview)</i></b> |
31+
| [aggregate](./firestore_lite_pipelines.aliasedaggregate.md#aliasedaggregateaggregate) | | [AggregateFunction](./firestore_lite_pipelines.aggregatefunction.md#aggregatefunction_class) | |
32+
| [alias](./firestore_lite_pipelines.aliasedaggregate.md#aliasedaggregatealias) | | string | |
3633

3734
## AliasedAggregate.(constructor)
3835

39-
> 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.
40-
>
41-
4236
Constructs a new instance of the `AliasedAggregate` class
4337

4438
<b>Signature:</b>
@@ -57,9 +51,6 @@ constructor(aggregate: AggregateFunction, alias: string, _methodName: string | u
5751

5852
## AliasedAggregate.aggregate
5953

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-
6354
<b>Signature:</b>
6455

6556
```typescript
@@ -68,9 +59,6 @@ readonly aggregate: AggregateFunction;
6859

6960
## AliasedAggregate.alias
7061

71-
> 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.
72-
>
73-
7462
<b>Signature:</b>
7563

7664
```typescript

‎docs-devsite/firestore_lite_pipelines.aliasedexpression.md‎

Lines changed: 5 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,6 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# AliasedExpression 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-
1713
<b>Signature:</b>
1814

1915
```typescript
@@ -25,22 +21,19 @@ export declare class AliasedExpression implements Selectable
2521
2622
| Constructor | Modifiers | Description |
2723
| --- | --- | --- |
28-
| [(constructor)(expr, alias, \_methodName)](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionconstructor) | | <b><i>(Public Preview)</i></b> Constructs a new instance of the <code>AliasedExpression</code> class |
24+
| [(constructor)(expr, alias, \_methodName)](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionconstructor) | | Constructs a new instance of the <code>AliasedExpression</code> class |
2925
3026
## Properties
3127
3228
| Property | Modifiers | Type | Description |
3329
| --- | --- | --- | --- |
34-
| [alias](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionalias) | | string | <b><i>(Public Preview)</i></b> |
35-
| [expr](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionexpr) | | [Expression](./firestore_lite_pipelines.expression.md#expression_class) | <b><i>(Public Preview)</i></b> |
36-
| [exprType](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionexprtype) | | [ExpressionType](./firestore_lite_pipelines.md#expressiontype) | <b><i>(Public Preview)</i></b> |
37-
| [selectable](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionselectable) | | true | <b><i>(Public Preview)</i></b> |
30+
| [alias](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionalias) | | string | |
31+
| [expr](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionexpr) | | [Expression](./firestore_lite_pipelines.expression.md#expression_class) | |
32+
| [exprType](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionexprtype) | | [ExpressionType](./firestore_lite_pipelines.md#expressiontype) | |
33+
| [selectable](./firestore_lite_pipelines.aliasedexpression.md#aliasedexpressionselectable) | | true | |
3834
3935
## AliasedExpression.(constructor)
4036
41-
> 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.
42-
>
43-
4437
Constructs a new instance of the `AliasedExpression` class
4538
4639
<b>Signature:</b>
@@ -59,9 +52,6 @@ constructor(expr: Expression, alias: string, _methodName: string | undefined);
5952
6053
## AliasedExpression.alias
6154
62-
> 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.
63-
>
64-
6555
<b>Signature:</b>
6656
6757
```typescript
@@ -70,9 +60,6 @@ readonly alias: string;
7060
7161
## AliasedExpression.expr
7262
73-
> 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.
74-
>
75-
7663
<b>Signature:</b>
7764
7865
```typescript
@@ -81,9 +68,6 @@ readonly expr: Expression;
8168
8269
## AliasedExpression.exprType
8370
84-
> 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.
85-
>
86-
8771
<b>Signature:</b>
8872
8973
```typescript
@@ -92,9 +76,6 @@ exprType: ExpressionType;
9276
9377
## AliasedExpression.selectable
9478
95-
> 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.
96-
>
97-
9879
<b>Signature:</b>
9980
10081
```typescript

‎docs-devsite/firestore_lite_pipelines.booleanexpression.md‎

Lines changed: 7 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# BooleanExpression 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-
1613
An interface that represents a filter condition.
1714

1815
<b>Signature:</b>
@@ -26,19 +23,16 @@ export declare abstract class BooleanExpression extends Expression
2623
2724
| Method | Modifiers | Description |
2825
| --- | --- | --- |
29-
| [conditional(thenExpr, elseExpr)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressionconditional) | | <b><i>(Public Preview)</i></b> Creates a conditional expression that evaluates to the 'then' expression if <code>this</code> expression evaluates to <code>true</code>, or evaluates to the 'else' expression if <code>this</code> expressions evaluates <code>false</code>. |
30-
| [countIf()](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioncountif) | | <b><i>(Public Preview)</i></b> Creates an aggregation that finds the count of input documents satisfying this boolean expression. |
31-
| [ifError(catchValue)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioniferror) | | <b><i>(Public Preview)</i></b> Creates an expression that returns the <code>catch</code> argument if there is an error, else return the result of this expression. |
32-
| [ifError(catchValue)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioniferror) | | <b><i>(Public Preview)</i></b> Creates an expression that returns the <code>catch</code> argument if there is an error, else return the result of this expression. |
33-
| [ifError(catchValue)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioniferror) | | <b><i>(Public Preview)</i></b> Creates an expression that returns the <code>catch</code> argument if there is an error, else return the result of this expression. |
34-
| [ifError(catchValue)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioniferror) | | <b><i>(Public Preview)</i></b> Creates an expression that returns the <code>catch</code> argument if there is an error, else return the result of this expression. |
35-
| [not()](./firestore_lite_pipelines.booleanexpression.md#booleanexpressionnot) | | <b><i>(Public Preview)</i></b> Creates an expression that negates this boolean expression. |
26+
| [conditional(thenExpr, elseExpr)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressionconditional) | | Creates a conditional expression that evaluates to the 'then' expression if <code>this</code> expression evaluates to <code>true</code>, or evaluates to the 'else' expression if <code>this</code> expressions evaluates <code>false</code>. |
27+
| [countIf()](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioncountif) | | Creates an aggregation that finds the count of input documents satisfying this boolean expression. |
28+
| [ifError(catchValue)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioniferror) | | Creates an expression that returns the <code>catch</code> argument if there is an error, else return the result of this expression. |
29+
| [ifError(catchValue)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioniferror) | | Creates an expression that returns the <code>catch</code> argument if there is an error, else return the result of this expression. |
30+
| [ifError(catchValue)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioniferror) | | Creates an expression that returns the <code>catch</code> argument if there is an error, else return the result of this expression. |
31+
| [ifError(catchValue)](./firestore_lite_pipelines.booleanexpression.md#booleanexpressioniferror) | | Creates an expression that returns the <code>catch</code> argument if there is an error, else return the result of this expression. |
32+
| [not()](./firestore_lite_pipelines.booleanexpression.md#booleanexpressionnot) | | Creates an expression that negates this boolean expression. |
3633
3734
## BooleanExpression.conditional()
3835
39-
> 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.
40-
>
41-
4236
Creates a conditional expression that evaluates to the 'then' expression if `this` expression evaluates to `true`<!-- -->, or evaluates to the 'else' expression if `this` expressions evaluates `false`<!-- -->.
4337
4438
<b>Signature:</b>
@@ -71,9 +65,6 @@ field("age").greaterThanOrEqual(18).conditional(constant("Adult"), constant("Min
7165
7266
## BooleanExpression.countIf()
7367
74-
> 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.
75-
>
76-
7768
Creates an aggregation that finds the count of input documents satisfying this boolean expression.
7869
7970
<b>Signature:</b>
@@ -98,9 +89,6 @@ field("score").greaterThan(90).countIf().as("highestScore");
9889
9990
## BooleanExpression.ifError()
10091
101-
> 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.
102-
>
103-
10492
Creates an expression that returns the `catch` argument if there is an error, else return the result of this expression.
10593
10694
<b>Signature:</b>
@@ -133,9 +121,6 @@ constant(50).divide(field('length')).greaterThan(1).ifError(constant(false));
133121
134122
## BooleanExpression.ifError()
135123
136-
> 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.
137-
>
138-
139124
Creates an expression that returns the `catch` argument if there is an error, else return the result of this expression.
140125
141126
<b>Signature:</b>
@@ -168,9 +153,6 @@ constant(50).divide(field('length')).greaterThan(1).ifError(false);
168153
169154
## BooleanExpression.ifError()
170155
171-
> 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.
172-
>
173-
174156
Creates an expression that returns the `catch` argument if there is an error, else return the result of this expression.
175157
176158
<b>Signature:</b>
@@ -202,9 +184,6 @@ constant(50).divide(field('length')).greaterThan(1).ifError(constant(0));
202184
203185
## BooleanExpression.ifError()
204186
205-
> 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.
206-
>
207-
208187
Creates an expression that returns the `catch` argument if there is an error, else return the result of this expression.
209188
210189
<b>Signature:</b>
@@ -236,9 +215,6 @@ constant(50).divide(field('length')).greaterThan(1).ifError(0);
236215
237216
## BooleanExpression.not()
238217
239-
> 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.
240-
>
241-
242218
Creates an expression that negates this boolean expression.
243219
244220
<b>Signature:</b>

0 commit comments

Comments
 (0)