component.ts•1.42 kB
/* eslint-disable */
/**
* 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> =
{
index: {
checkRateLimit: FunctionReference<
"query",
"internal",
{
count?: number;
key?: string;
name: string;
reserve?: boolean;
throws?: boolean;
},
{ ok: boolean; retryAt?: number; ts?: number; value?: number },
Name
>;
rateLimit: FunctionReference<
"mutation",
"internal",
{
count?: number;
key?: string;
name: string;
reserve?: boolean;
throws?: boolean;
},
{ ok: boolean; retryAt?: number },
Name
>;
resetRateLimit: FunctionReference<
"mutation",
"internal",
{ key?: string; name: string },
any,
Name
>;
};
};