convex-test/convex/_generated/api.d.ts at 30c492226b96e5a6c99485e4672b71ba9d06ad0e · get-convex/convex-test · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/* eslint-disable */
/**
 * Generated `api` utility.
 *
 * THIS CODE IS AUTOMATICALLY GENERATED.
 *
 * To regenerate, run `npx convex dev`.
 * @module
 */

import type * as actions from "../actions.js";
import type * as argumentsValidation from "../argumentsValidation.js";
import type * as authentication from "../authentication.js";
import type * as component from "../component.js";
import type * as explicitTableNames from "../explicitTableNames.js";
import type * as helpers from "../helpers.js";
import type * as http from "../http.js";
import type * as messages from "../messages.js";
import type * as mutations from "../mutations.js";
import type * as pagination from "../pagination.js";
import type * as queries from "../queries.js";
import type * as returnsValidation from "../returnsValidation.js";
import type * as scheduler from "../scheduler.js";
import type * as storage from "../storage.js";
import type * as textSearch from "../textSearch.js";
import type * as vectorSearch from "../vectorSearch.js";

import type {
  ApiFromModules,
  FilterApi,
  FunctionReference,
} from "convex/server";

declare const fullApi: ApiFromModules<{
  actions: typeof actions;
  argumentsValidation: typeof argumentsValidation;
  authentication: typeof authentication;
  component: typeof component;
  explicitTableNames: typeof explicitTableNames;
  helpers: typeof helpers;
  http: typeof http;
  messages: typeof messages;
  mutations: typeof mutations;
  pagination: typeof pagination;
  queries: typeof queries;
  returnsValidation: typeof returnsValidation;
  scheduler: typeof scheduler;
  storage: typeof storage;
  textSearch: typeof textSearch;
  vectorSearch: typeof vectorSearch;
}>;

/**
 * A utility for referencing Convex functions in your app's public API.
 *
 * Usage:
 * ```js
 * const myFunctionReference = api.myModule.myFunction;
 * ```
 */
export declare const api: FilterApi<
  typeof fullApi,
  FunctionReference<any, "public">
>;

/**
 * A utility for referencing Convex functions in your app's internal API.
 *
 * Usage:
 * ```js
 * const myFunctionReference = internal.myModule.myFunction;
 * ```
 */
export declare const internal: FilterApi<
  typeof fullApi,
  FunctionReference<any, "internal">
>;

export declare const components: {
  counter: {
    public: {
      add: FunctionReference<
        "mutation",
        "internal",
        { count: number; name: string; shards?: number },
        null
      >;
      count: FunctionReference<"query", "internal", { name: string }, number>;
      countMany: FunctionReference<
        "action",
        "internal",
        { names: Array<string> },
        Array<number>
      >;
      mutationWithNestedQuery: FunctionReference<
        "mutation",
        "internal",
        {},
        any
      >;
      mutationWithNumberArg: FunctionReference<
        "mutation",
        "internal",
        { a: number },
        any
      >;
      schedule: FunctionReference<
        "mutation",
        "internal",
        { name: string },
        any
      >;
    };
  };
  counter2: {
    public: {
      add: FunctionReference<
        "mutation",
        "internal",
        { count: number; name: string; shards?: number },
        null
      >;
      count: FunctionReference<"query", "internal", { name: string }, number>;
      countMany: FunctionReference<
        "action",
        "internal",
        { names: Array<string> },
        Array<number>
      >;
      mutationWithNestedQuery: FunctionReference<
        "mutation",
        "internal",
        {},
        any
      >;
      mutationWithNumberArg: FunctionReference<
        "mutation",
        "internal",
        { a: number },
        any
      >;
      schedule: FunctionReference<
        "mutation",
        "internal",
        { name: string },
        any
      >;
    };
  };
};