@convex-dev/aggregate
Version:
Convex component to calculate counts and sums of values for efficient aggregation.
202 lines • 5.9 kB
TypeScript
/**
* Generated `ComponentApi` utility.
*
* THIS CODE IS AUTOMATICALLY GENERATED.
*
* To regenerate, run `npx convex dev`.
* @module
*/
import type { FunctionReference } from "convex/server";
/**
* A utility for referencing a Convex component's exposed API.
*
* Useful when expecting a parameter like `components.myComponent`.
* Usage:
* ```ts
* async function myFunction(ctx: QueryCtx, component: ComponentApi) {
* return ctx.runQuery(component.someFile.someQuery, { ...args });
* }
* ```
*/
export type ComponentApi<Name extends string | undefined = string | undefined> = {
btree: {
aggregateBetween: FunctionReference<"query", "internal", {
k1?: any;
k2?: any;
namespace?: any;
}, {
count: number;
sum: number;
}, Name>;
aggregateBetweenBatch: FunctionReference<"query", "internal", {
queries: Array<{
k1?: any;
k2?: any;
namespace?: any;
}>;
}, Array<{
count: number;
sum: number;
}>, Name>;
atNegativeOffset: FunctionReference<"query", "internal", {
k1?: any;
k2?: any;
namespace?: any;
offset: number;
}, {
k: any;
s: number;
v: any;
}, Name>;
atOffset: FunctionReference<"query", "internal", {
k1?: any;
k2?: any;
namespace?: any;
offset: number;
}, {
k: any;
s: number;
v: any;
}, Name>;
atOffsetBatch: FunctionReference<"query", "internal", {
queries: Array<{
k1?: any;
k2?: any;
namespace?: any;
offset: number;
}>;
}, Array<{
k: any;
s: number;
v: any;
}>, Name>;
get: FunctionReference<"query", "internal", {
key: any;
namespace?: any;
}, null | {
k: any;
s: number;
v: any;
}, Name>;
offset: FunctionReference<"query", "internal", {
k1?: any;
key: any;
namespace?: any;
}, number, Name>;
offsetUntil: FunctionReference<"query", "internal", {
k2?: any;
key: any;
namespace?: any;
}, number, Name>;
paginate: FunctionReference<"query", "internal", {
cursor?: string;
k1?: any;
k2?: any;
limit: number;
namespace?: any;
order: "asc" | "desc";
}, {
cursor: string;
isDone: boolean;
page: Array<{
k: any;
s: number;
v: any;
}>;
}, Name>;
paginateNamespaces: FunctionReference<"query", "internal", {
cursor?: string;
limit: number;
}, {
cursor: string;
isDone: boolean;
page: Array<any>;
}, Name>;
validate: FunctionReference<"query", "internal", {
namespace?: any;
}, any, Name>;
};
inspect: {
display: FunctionReference<"query", "internal", {
namespace?: any;
}, any, Name>;
dump: FunctionReference<"query", "internal", {
namespace?: any;
}, string, Name>;
inspectNode: FunctionReference<"query", "internal", {
namespace?: any;
node?: string;
}, null, Name>;
listTreeNodes: FunctionReference<"query", "internal", {
take?: number;
}, Array<{
_creationTime: number;
_id: string;
aggregate?: {
count: number;
sum: number;
};
items: Array<{
k: any;
s: number;
v: any;
}>;
subtrees: Array<string>;
}>, Name>;
listTrees: FunctionReference<"query", "internal", {
take?: number;
}, Array<{
_creationTime: number;
_id: string;
maxNodeSize: number;
namespace?: any;
root: string;
}>, Name>;
};
public: {
clear: FunctionReference<"mutation", "internal", {
maxNodeSize?: number;
namespace?: any;
rootLazy?: boolean;
}, null, Name>;
delete_: FunctionReference<"mutation", "internal", {
key: any;
namespace?: any;
}, null, Name>;
deleteIfExists: FunctionReference<"mutation", "internal", {
key: any;
namespace?: any;
}, any, Name>;
init: FunctionReference<"mutation", "internal", {
maxNodeSize?: number;
namespace?: any;
rootLazy?: boolean;
}, null, Name>;
insert: FunctionReference<"mutation", "internal", {
key: any;
namespace?: any;
summand?: number;
value: any;
}, null, Name>;
makeRootLazy: FunctionReference<"mutation", "internal", {
namespace?: any;
}, null, Name>;
replace: FunctionReference<"mutation", "internal", {
currentKey: any;
namespace?: any;
newKey: any;
newNamespace?: any;
summand?: number;
value: any;
}, null, Name>;
replaceOrInsert: FunctionReference<"mutation", "internal", {
currentKey: any;
namespace?: any;
newKey: any;
newNamespace?: any;
summand?: number;
value: any;
}, any, Name>;
};
};
//# sourceMappingURL=component.d.ts.map