Skip to content

Commit c71d720

Browse files
committed
Remove beta notation and timeout for tests and regenerate documentation
1 parent 7804473 commit c71d720

9 files changed

Lines changed: 24 additions & 23 deletions

File tree

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1191,6 +1191,14 @@ export class Ordering {
11911191
readonly expr: Expression;
11921192
}
11931193

1194+
// @public
1195+
function parent_2(documentPath: string | DocumentReference): FunctionExpression;
1196+
1197+
// @public
1198+
function parent_2(documentPathExpr: Expression): FunctionExpression;
1199+
1200+
export { parent_2 as parent }
1201+
11941202
// @public
11951203
export class Pipeline {
11961204
addFields(field: Selectable, ...additionalFields: Selectable[]): Pipeline;

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1194,6 +1194,14 @@ export class Ordering {
11941194
readonly expr: Expression;
11951195
}
11961196

1197+
// @public
1198+
function parent_2(documentPath: string | DocumentReference): FunctionExpression;
1199+
1200+
// @public
1201+
function parent_2(documentPathExpr: Expression): FunctionExpression;
1202+
1203+
export { parent_2 as parent }
1204+
11971205
// @public (undocumented)
11981206
export class Pipeline {
11991207
addFields(field: Selectable, ...additionalFields: Selectable[]): Pipeline;

docs-devsite/firestore_lite_pipelines.expression.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,7 @@ export declare abstract class Expression
145145
| [notEqual(value)](./firestore_lite_pipelines.expression.md#expressionnotequal) | | Creates an expression that checks if this expression is not equal to a constant value. |
146146
| [notEqualAny(values)](./firestore_lite_pipelines.expression.md#expressionnotequalany) | | Creates an expression that checks if this expression is not equal to any of the provided values or expressions. |
147147
| [notEqualAny(arrayExpression)](./firestore_lite_pipelines.expression.md#expressionnotequalany) | | Creates an expression that checks if this expression is not equal to any of the values in the evaluated expression. |
148+
| [parent()](./firestore_lite_pipelines.expression.md#expressionparent) | | Creates an expression that returns the parent document reference of a document reference. |
148149
| [pow(exponent)](./firestore_lite_pipelines.expression.md#expressionpow) | | Creates an expression that returns the value of this expression raised to the power of another expression. |
149150
| [pow(exponent)](./firestore_lite_pipelines.expression.md#expressionpow) | | Creates an expression that returns the value of this expression raised to the power of a constant value. |
150151
| [regexContains(pattern)](./firestore_lite_pipelines.expression.md#expressionregexcontains) | | Creates an expression that checks if a string contains a specified regular expression as a substring. |
@@ -3445,9 +3446,6 @@ field("status").notEqualAny(field('rejectedStatuses'));
34453446
34463447
## Expression.parent()
34473448
3448-
> 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.
3449-
>
3450-
34513449
Creates an expression that returns the parent document reference of a document reference.
34523450
34533451
<b>Signature:</b>

docs-devsite/firestore_lite_pipelines.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,10 @@ https://github.com/firebase/firebase-js-sdk
6666
| [switchOn(condition, result, others)](./firestore_lite_pipelines.md#switchon_02b8caf) | Creates an expression that evaluates to the result corresponding to the first true condition. |
6767
| <b>function(documentPath, ...)</b> |
6868
| [documentId(documentPath)](./firestore_lite_pipelines.md#documentid_cef293c) | Creates an expression that returns the document ID from a path. |
69+
| [parent\_2(documentPath)](./firestore_lite_pipelines.md#parent_2_cef293c) | Creates an expression that returns the parent document reference of a document reference. |
6970
| <b>function(documentPathExpr, ...)</b> |
7071
| [documentId(documentPathExpr)](./firestore_lite_pipelines.md#documentid_9a69021) | Creates an expression that returns the document ID from a path. |
72+
| [parent\_2(documentPathExpr)](./firestore_lite_pipelines.md#parent_2_9a69021) | Creates an expression that returns the parent document reference of a document reference. |
7173
| <b>function(element, ...)</b> |
7274
| [notEqualAny(element, values)](./firestore_lite_pipelines.md#notequalany_c2c5bcb) | Creates an expression that checks if an expression is not equal to any of the provided values or expressions. |
7375
| [notEqualAny(element, arrayExpression)](./firestore_lite_pipelines.md#notequalany_16b2851) | Creates an expression that checks if an expression is not equal to any of the provided values or expressions. |
@@ -1823,9 +1825,6 @@ documentId(myDocumentReference);
18231825

18241826
### parent\_2(documentPath) {:#parent_2_cef293c}
18251827

1826-
> 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.
1827-
>
1828-
18291828
Creates an expression that returns the parent document reference of a document reference.
18301829

18311830
<b>Signature:</b>
@@ -1890,9 +1889,6 @@ documentId(field("__path__"));
18901889

18911890
### parent\_2(documentPathExpr) {:#parent_2_9a69021}
18921891

1893-
> 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.
1894-
>
1895-
18961892
Creates an expression that returns the parent document reference of a document reference.
18971893

18981894
<b>Signature:</b>

docs-devsite/firestore_pipelines.expression.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,7 @@ export declare abstract class Expression
145145
| [notEqual(value)](./firestore_pipelines.expression.md#expressionnotequal) | | Creates an expression that checks if this expression is not equal to a constant value. |
146146
| [notEqualAny(values)](./firestore_pipelines.expression.md#expressionnotequalany) | | Creates an expression that checks if this expression is not equal to any of the provided values or expressions. |
147147
| [notEqualAny(arrayExpression)](./firestore_pipelines.expression.md#expressionnotequalany) | | Creates an expression that checks if this expression is not equal to any of the values in the evaluated expression. |
148+
| [parent()](./firestore_pipelines.expression.md#expressionparent) | | Creates an expression that returns the parent document reference of a document reference. |
148149
| [pow(exponent)](./firestore_pipelines.expression.md#expressionpow) | | Creates an expression that returns the value of this expression raised to the power of another expression. |
149150
| [pow(exponent)](./firestore_pipelines.expression.md#expressionpow) | | Creates an expression that returns the value of this expression raised to the power of a constant value. |
150151
| [regexContains(pattern)](./firestore_pipelines.expression.md#expressionregexcontains) | | Creates an expression that checks if a string contains a specified regular expression as a substring. |
@@ -3445,9 +3446,6 @@ field("status").notEqualAny(field('rejectedStatuses'));
34453446
34463447
## Expression.parent()
34473448
3448-
> 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.
3449-
>
3450-
34513449
Creates an expression that returns the parent document reference of a document reference.
34523450
34533451
<b>Signature:</b>

docs-devsite/firestore_pipelines.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,10 @@ https://github.com/firebase/firebase-js-sdk
6666
| [switchOn(condition, result, others)](./firestore_pipelines.md#switchon_02b8caf) | Creates an expression that evaluates to the result corresponding to the first true condition. |
6767
| <b>function(documentPath, ...)</b> |
6868
| [documentId(documentPath)](./firestore_pipelines.md#documentid_cef293c) | Creates an expression that returns the document ID from a path. |
69+
| [parent\_2(documentPath)](./firestore_pipelines.md#parent_2_cef293c) | Creates an expression that returns the parent document reference of a document reference. |
6970
| <b>function(documentPathExpr, ...)</b> |
7071
| [documentId(documentPathExpr)](./firestore_pipelines.md#documentid_9a69021) | Creates an expression that returns the document ID from a path. |
72+
| [parent\_2(documentPathExpr)](./firestore_pipelines.md#parent_2_9a69021) | Creates an expression that returns the parent document reference of a document reference. |
7173
| <b>function(element, ...)</b> |
7274
| [notEqualAny(element, values)](./firestore_pipelines.md#notequalany_c2c5bcb) | Creates an expression that checks if an expression is not equal to any of the provided values or expressions. |
7375
| [notEqualAny(element, arrayExpression)](./firestore_pipelines.md#notequalany_16b2851) | Creates an expression that checks if an expression is not equal to any of the provided values or expressions. |
@@ -1829,9 +1831,6 @@ documentId(myDocumentReference);
18291831

18301832
### parent\_2(documentPath) {:#parent_2_cef293c}
18311833

1832-
> 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.
1833-
>
1834-
18351834
Creates an expression that returns the parent document reference of a document reference.
18361835

18371836
<b>Signature:</b>
@@ -1896,9 +1895,6 @@ documentId(field("__path__"));
18961895

18971896
### parent\_2(documentPathExpr) {:#parent_2_9a69021}
18981897

1899-
> 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.
1900-
>
1901-
19021898
Creates an expression that returns the parent document reference of a document reference.
19031899

19041900
<b>Signature:</b>

packages/firestore/src/lite-api/expressions.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2600,7 +2600,6 @@ export abstract class Expression implements ProtoValueSerializable, UserData {
26002600
}
26012601

26022602
/**
2603-
* @beta
26042603
*
26052604
* Creates an expression that returns a substring of the results of this expression.
26062605
*
@@ -4545,7 +4544,6 @@ export function parent(
45454544
): FunctionExpression;
45464545

45474546
/**
4548-
* @beta
45494547
*
45504548
* Creates an expression that returns the parent document reference of a document reference.
45514549
*
@@ -4568,7 +4566,6 @@ export function parent(
45684566
}
45694567

45704568
/**
4571-
* @beta
45724569
*
45734570
* Creates an expression that returns a substring of a string or byte array.
45744571
*

packages/firestore/test/integration/api/pipeline.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4684,7 +4684,7 @@ apiDescribe.skipClassic('Pipelines', persistence => {
46844684
parentIdStatic: 'book4',
46854685
parentIdInstance: 'book4'
46864686
});
4687-
}).timeout(10000);
4687+
});
46884688

46894689
it('supports substring', async () => {
46904690
let snapshot = await execute(

packages/firestore/test/lite/pipeline.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4742,7 +4742,7 @@ describe.skipClassic('Firestore Pipelines', () => {
47424742
parentIdStatic: 'book4',
47434743
parentIdInstance: 'book4'
47444744
});
4745-
}).timeout(10000);
4745+
});
47464746

47474747
it('supports substring', async () => {
47484748
let snapshot = await execute(

0 commit comments

Comments
 (0)