Skip to content

Commit f6f1116

Browse files
yvonnep165yvonnep165
committed
Fix documentation error
1 parent b80dbdf commit f6f1116

4 files changed

Lines changed: 5 additions & 95 deletions

File tree

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

Lines changed: 3 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -772,14 +772,6 @@ export abstract class Expression {
772772
/* Excluded from this release type: _readUserData */
773773
timestampExtract(part: Expression, timezone?: string | Expression): FunctionExpression;
774774
/* Excluded from this release type: _readUserData */
775-
timestampDiff(start: Expression, unit: Expression): FunctionExpression;
776-
/* Excluded from this release type: _readUserData */
777-
timestampDiff(start: string | Expression, unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day'): FunctionExpression;
778-
/* Excluded from this release type: _readUserData */
779-
timestampExtract(part: TimePart, timezone?: string | Expression): FunctionExpression;
780-
/* Excluded from this release type: _readUserData */
781-
timestampExtract(part: Expression, timezone?: string | Expression): FunctionExpression;
782-
/* Excluded from this release type: _readUserData */
783775
timestampSubtract(unit: Expression, amount: Expression): FunctionExpression;
784776
/* Excluded from this release type: _readUserData */
785777
timestampSubtract(unit: TimeUnit, amount: number): FunctionExpression;
@@ -1492,13 +1484,13 @@ export function sum(expression: Expression): AggregateFunction;
14921484
export function sum(fieldName: string): AggregateFunction;
14931485

14941486
// @beta
1495-
export type TimeGranularity = TimeUnit | 'week' | 'week(monday)' | 'week(tuesday)' | 'week(wednesday)' | 'week(thursday)' | 'week(friday)' | 'week(saturday)' | 'week(sunday)' | 'isoweek' | 'month' | 'quarter' | 'year' | 'isoyear';
1487+
export function switchOn(condition: BooleanExpression, result: Expression, ...others: Array<BooleanExpression | Expression>): FunctionExpression;
14961488

14971489
// @beta
1498-
export type TimePart = TimeGranularity | 'dayofweek' | 'dayofyear';
1490+
export type TimeGranularity = TimeUnit | 'week' | 'week(monday)' | 'week(tuesday)' | 'week(wednesday)' | 'week(thursday)' | 'week(friday)' | 'week(saturday)' | 'week(sunday)' | 'isoweek' | 'month' | 'quarter' | 'year' | 'isoyear';
14991491

15001492
// @beta
1501-
export function switchOn(condition: BooleanExpression, result: Expression, ...others: Array<BooleanExpression | Expression>): FunctionExpression;
1493+
export type TimePart = TimeGranularity | 'dayofweek' | 'dayofyear';
15021494

15031495
// @beta
15041496
export function timestampAdd(timestamp: Expression, unit: Expression, amount: Expression): FunctionExpression;
@@ -1533,30 +1525,6 @@ export function timestampExtract(timestampExpression: Expression, part: TimePart
15331525
// @beta
15341526
export function timestampExtract(timestampExpression: Expression, part: Expression, timezone?: string | Expression): FunctionExpression;
15351527

1536-
// @beta
1537-
export function timestampDiff(endFieldName: string, startFieldName: string, unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | Expression): FunctionExpression;
1538-
1539-
// @beta
1540-
export function timestampDiff(endFieldName: string, startExpression: Expression, unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | Expression): FunctionExpression;
1541-
1542-
// @beta
1543-
export function timestampDiff(endExpression: Expression, startFieldName: string, unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | Expression): FunctionExpression;
1544-
1545-
// @beta
1546-
export function timestampDiff(endExpression: Expression, startExpression: Expression, unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | Expression): FunctionExpression;
1547-
1548-
// @beta
1549-
export function timestampExtract(fieldName: string, part: TimePart, timezone?: string | Expression): FunctionExpression;
1550-
1551-
// @beta
1552-
export function timestampExtract(fieldName: string, part: Expression, timezone?: string | Expression): FunctionExpression;
1553-
1554-
// @beta
1555-
export function timestampExtract(timestampExpression: Expression, part: TimePart, timezone?: string | Expression): FunctionExpression;
1556-
1557-
// @beta
1558-
export function timestampExtract(timestampExpression: Expression, part: Expression, timezone?: string | Expression): FunctionExpression;
1559-
15601528
// @beta
15611529
export function timestampSubtract(timestamp: Expression, unit: Expression, amount: Expression): FunctionExpression;
15621530

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

Lines changed: 2 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -775,14 +775,6 @@ export abstract class Expression {
775775
/* Excluded from this release type: _readUserData */
776776
timestampExtract(part: Expression, timezone?: string | Expression): FunctionExpression;
777777
/* Excluded from this release type: _readUserData */
778-
timestampDiff(start: Expression, unit: Expression): FunctionExpression;
779-
/* Excluded from this release type: _readUserData */
780-
timestampDiff(start: string | Expression, unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day'): FunctionExpression;
781-
/* Excluded from this release type: _readUserData */
782-
timestampExtract(part: TimePart, timezone?: string | Expression): FunctionExpression;
783-
/* Excluded from this release type: _readUserData */
784-
timestampExtract(part: Expression, timezone?: string | Expression): FunctionExpression;
785-
/* Excluded from this release type: _readUserData */
786778
timestampSubtract(unit: Expression, amount: Expression): FunctionExpression;
787779
/* Excluded from this release type: _readUserData */
788780
timestampSubtract(unit: TimeUnit, amount: number): FunctionExpression;
@@ -1534,10 +1526,10 @@ export function sum(expression: Expression): AggregateFunction;
15341526
export function sum(fieldName: string): AggregateFunction;
15351527

15361528
// @beta
1537-
export type TimeGranularity = TimeUnit | 'week' | 'week(monday)' | 'week(tuesday)' | 'week(wednesday)' | 'week(thursday)' | 'week(friday)' | 'week(saturday)' | 'week(sunday)' | 'isoweek' | 'month' | 'quarter' | 'year' | 'isoyear';
1529+
export function switchOn(condition: BooleanExpression, result: Expression, ...others: Array<BooleanExpression | Expression>): FunctionExpression;
15381530

15391531
// @beta
1540-
export function switchOn(condition: BooleanExpression, result: Expression, ...others: Array<BooleanExpression | Expression>): FunctionExpression;
1532+
export type TimeGranularity = TimeUnit | 'week' | 'week(monday)' | 'week(tuesday)' | 'week(wednesday)' | 'week(thursday)' | 'week(friday)' | 'week(saturday)' | 'week(sunday)' | 'isoweek' | 'month' | 'quarter' | 'year' | 'isoyear';
15411533

15421534
// @beta
15431535
export type TimePart = TimeGranularity | 'dayofweek' | 'dayofyear';
@@ -1575,30 +1567,6 @@ export function timestampExtract(timestampExpression: Expression, part: TimePart
15751567
// @beta
15761568
export function timestampExtract(timestampExpression: Expression, part: Expression, timezone?: string | Expression): FunctionExpression;
15771569

1578-
// @beta
1579-
export function timestampDiff(endFieldName: string, startFieldName: string, unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | Expression): FunctionExpression;
1580-
1581-
// @beta
1582-
export function timestampDiff(endFieldName: string, startExpression: Expression, unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | Expression): FunctionExpression;
1583-
1584-
// @beta
1585-
export function timestampDiff(endExpression: Expression, startFieldName: string, unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | Expression): FunctionExpression;
1586-
1587-
// @beta
1588-
export function timestampDiff(endExpression: Expression, startExpression: Expression, unit: 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | Expression): FunctionExpression;
1589-
1590-
// @beta
1591-
export function timestampExtract(fieldName: string, part: TimePart, timezone?: string | Expression): FunctionExpression;
1592-
1593-
// @beta
1594-
export function timestampExtract(fieldName: string, part: Expression, timezone?: string | Expression): FunctionExpression;
1595-
1596-
// @beta
1597-
export function timestampExtract(timestampExpression: Expression, part: TimePart, timezone?: string | Expression): FunctionExpression;
1598-
1599-
// @beta
1600-
export function timestampExtract(timestampExpression: Expression, part: Expression, timezone?: string | Expression): FunctionExpression;
1601-
16021570
// @beta
16031571
export function timestampSubtract(timestamp: Expression, unit: Expression, amount: Expression): FunctionExpression;
16041572

‎docs-devsite/firestore_lite_pipelines.md‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12611,19 +12611,6 @@ Specify time units for expressions.
1261112611
export declare type TimeUnit = 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day';
1261212612
```
1261312613

12614-
## TimePart
12615-
12616-
> 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.
12617-
>
12618-
12619-
Specify time parts for `timestampExtract` expressions.
12620-
12621-
<b>Signature:</b>
12622-
12623-
```typescript
12624-
export declare type TimePart = TimeGranularity | 'dayofweek' | 'dayofyear';
12625-
```
12626-
1262712614
## Type
1262812615

1262912616
> 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.

‎docs-devsite/firestore_pipelines.md‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12686,19 +12686,6 @@ Specify time units for expressions.
1268612686
export declare type TimeUnit = 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day';
1268712687
```
1268812688

12689-
## TimePart
12690-
12691-
> 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.
12692-
>
12693-
12694-
Specify time parts for `timestampExtract` expressions.
12695-
12696-
<b>Signature:</b>
12697-
12698-
```typescript
12699-
export declare type TimePart = TimeGranularity | 'dayofweek' | 'dayofyear';
12700-
```
12701-
1270212689
## Type
1270312690

1270412691
> 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.

0 commit comments

Comments
 (0)