Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 56 additions & 1 deletion handwritten/firestore/api-report/firestore.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ class AggregateFunction implements AggregateFunction, HasUserData {
_createdFromLiteral: boolean;
// (undocumented)
expressionType: firestore.Pipelines.ExpressionType;
over(frame: firestore.OneOf<{
documents: firestore.Pipelines.DocumentWindowFrame;
range: firestore.Pipelines.RangeWindowFrame;
}>): WindowFunction;
// (undocumented)
_protoValueType: "ProtoValue";
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration
Expand Down Expand Up @@ -170,6 +174,23 @@ class AliasedExpression implements firestore.Pipelines.Selectable, HasUserData {
_validateUserData(ignoreUndefinedProperties: boolean): void;
}

// @public
class AliasedWindowFunction implements firestore.Pipelines.AliasedWindowFunction, HasUserData {
constructor(_windowFunction: WindowFunction, _alias: string);
// (undocumented)
readonly _alias: string;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration
//
// @internal
_createdFromLiteral: boolean;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration
//
// @internal (undocumented)
_validateUserData(ignoreUndefinedProperties: boolean): void;
// (undocumented)
readonly _windowFunction: WindowFunction;
}

// @public
function and(first: BooleanExpression, second: BooleanExpression, ...more: BooleanExpression[]): BooleanExpression;

Expand Down Expand Up @@ -1998,6 +2019,8 @@ class Pipeline implements firestore.Pipelines.Pipeline {
addFields(field: firestore.Pipelines.Selectable, ...additionalFields: firestore.Pipelines.Selectable[]): Pipeline;
// Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
addFields(options: firestore.Pipelines.AddFieldsStageOptions): Pipeline;
addWindowFields(window: firestore.Pipelines.WindowSpec, field: firestore.Pipelines.AliasedAggregate | firestore.Pipelines.AliasedWindowFunction, ...additionalFields: Array<firestore.Pipelines.AliasedAggregate | firestore.Pipelines.AliasedWindowFunction>): Pipeline;
addWindowFields(options: firestore.Pipelines.AddWindowFieldsStageOptions): Pipeline;
aggregate(accumulator: firestore.Pipelines.AliasedAggregate, ...additionalAccumulators: firestore.Pipelines.AliasedAggregate[]): Pipeline;
aggregate(options: firestore.Pipelines.AggregateStageOptions): Pipeline;
define(aliasedExpression: firestore.Pipelines.AliasedExpression, ...additionalExpressions: firestore.Pipelines.AliasedExpression[]): Pipeline;
Expand Down Expand Up @@ -2274,7 +2297,10 @@ declare namespace Pipelines {
coalesce,
documentMatches,
score,
geoDistance
geoDistance,
WindowFunction,
AliasedWindowFunction,
rank
}
}
export { Pipelines }
Expand Down Expand Up @@ -2616,6 +2642,9 @@ export class QuerySnapshot<AppModelType = firestore.DocumentData, DbModelType ex
// @public
function rand(): FunctionExpression;

// @public
function rank(): WindowFunction;

// @public
function regexContains(fieldName: string, pattern: string): BooleanExpression;

Expand Down Expand Up @@ -3173,6 +3202,32 @@ export class VectorValue implements firestore.VectorValue {
_toProto(serializer: Serializer): api.IValue;
}

// @public
class WindowFunction implements firestore.Pipelines.WindowFunction, HasUserData {
constructor(name: string, params?: Expression[]);
as(name: string): AliasedWindowFunction;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration
//
// @internal
_createdFromLiteral: boolean;
// (undocumented)
expressionType: firestore.Pipelines.ExpressionType;
over(frame: firestore.OneOf<{
documents: firestore.Pipelines.DocumentWindowFrame;
range: firestore.Pipelines.RangeWindowFrame;
}>): WindowFunction;
// (undocumented)
_protoValueType: "ProtoValue";
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration
//
// @internal (undocumented)
_toProto(serializer: Serializer): api.IValue;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@private" is not defined in this configuration
//
// @internal (undocumented)
_validateUserData(ignoreUndefinedProperties: boolean): void;
}

// Warning: (tsdoc-undefined-tag) The TSDoc tag "@class" is not defined in this configuration
//
// @public
Expand Down
Loading
Loading