@convex-dev/aggregate/src/component/_generated/api.d.ts

[](https://badge.fury.io/js/@convex-dev%2Faggregate)

/* prettier-ignore-start */

/* eslint-disable */
/**
 * Generated `api` utility.
 *
 * THIS CODE IS AUTOMATICALLY GENERATED.
 *
 * To regenerate, run `npx convex dev`.
 * @module
 */

import type * as btree from "../btree.js";
import type * as compare from "../compare.js";
import type * as inspect from "../inspect.js";
import type * as public from "../public.js";

import type {
  ApiFromModules,
  FilterApi,
  FunctionReference,
} from "convex/server";
/**
 * A utility for referencing Convex functions in your app's API.
 *
 * Usage:
 * ```js
 * const myFunctionReference = api.myModule.myFunction;
 * ```
 */
declare const fullApi: ApiFromModules<{
  btree: typeof btree;
  compare: typeof compare;
  inspect: typeof inspect;
  public: typeof public;
}>;
export type Mounts = {
  btree: {
    aggregateBetween: FunctionReference<
      "query",
      "public",
      { k1?: any; k2?: any },
      { count: number; sum: number }
    >;
    aggregateBetweenHandler: FunctionReference<
      "query",
      "public",
      { k1?: any; k2?: any },
      { count: number; sum: number }
    >;
    atIndex: FunctionReference<
      "query",
      "public",
      { index: number },
      { k: any; s: number; v: any }
    >;
    atIndexHandler: FunctionReference<
      "query",
      "public",
      { index: number },
      { k: any; s: number; v: any }
    >;
    count: FunctionReference<"query", "public", {}, any>;
    countHandler: FunctionReference<"query", "public", {}, any>;
    get: FunctionReference<
      "query",
      "public",
      { key: any },
      null | { k: any; s: number; v: any }
    >;
    getHandler: FunctionReference<
      "query",
      "public",
      { key: any },
      null | { k: any; s: number; v: any }
    >;
    rank: FunctionReference<"query", "public", { key: any }, number>;
    rankHandler: FunctionReference<"query", "public", { key: any }, number>;
    sum: FunctionReference<"query", "public", {}, number>;
    sumHandler: FunctionReference<"query", "public", {}, number>;
    validate: FunctionReference<"query", "public", {}, any>;
    validateTree: FunctionReference<"query", "public", {}, any>;
  };
  inspect: {
    display: FunctionReference<"query", "public", {}, any>;
    dump: FunctionReference<"query", "public", {}, string>;
    inspectNode: FunctionReference<"query", "public", { node?: string }, null>;
  };
  public: {
    clear: FunctionReference<
      "mutation",
      "public",
      { maxNodeSize?: number; rootLazy?: boolean },
      null
    >;
    delete_: FunctionReference<"mutation", "public", { key: any }, null>;
    init: FunctionReference<
      "mutation",
      "public",
      { maxNodeSize?: number },
      null
    >;
    insert: FunctionReference<
      "mutation",
      "public",
      { key: any; summand?: number; value: any },
      null
    >;
    makeRootLazy: FunctionReference<"mutation", "public", {}, null>;
    replace: FunctionReference<
      "mutation",
      "public",
      { currentKey: any; newKey: any; summand?: number; value: any },
      null
    >;
  };
};
// For now fullApiWithMounts is only fullApi which provides
// jump-to-definition in component client code.
// Use Mounts for the same type without the inference.
declare const fullApiWithMounts: typeof fullApi;

export declare const api: FilterApi<
  typeof fullApiWithMounts,
  FunctionReference<any, "public">
>;
export declare const internal: FilterApi<
  typeof fullApiWithMounts,
  FunctionReference<any, "internal">
>;

export declare const components: {};

/* prettier-ignore-end */