90 lines
3.4 KiB
JavaScript
90 lines
3.4 KiB
JavaScript
/* eslint-disable */
|
|
/**
|
|
* Generated utilities for implementing server-side Convex query and mutation functions.
|
|
*
|
|
* THIS CODE IS AUTOMATICALLY GENERATED.
|
|
*
|
|
* To regenerate, run `npx convex dev`.
|
|
* @module
|
|
*/
|
|
|
|
import {
|
|
actionGeneric,
|
|
httpActionGeneric,
|
|
queryGeneric,
|
|
mutationGeneric,
|
|
internalActionGeneric,
|
|
internalMutationGeneric,
|
|
internalQueryGeneric,
|
|
} from "convex/server";
|
|
|
|
/**
|
|
* Define a query in this Convex app's public API.
|
|
*
|
|
* This function will be allowed to read your Convex database and will be accessible from the client.
|
|
*
|
|
* @param func - The query function. It receives a {@link QueryCtx} as its first argument.
|
|
* @returns The wrapped query. Include this as an `export` to name it and make it accessible.
|
|
*/
|
|
export const query = queryGeneric;
|
|
|
|
/**
|
|
* Define a query that is only accessible from other Convex functions (but not from the client).
|
|
*
|
|
* This function will be allowed to read from your Convex database. It will not be accessible from the client.
|
|
*
|
|
* @param func - The query function. It receives a {@link QueryCtx} as its first argument.
|
|
* @returns The wrapped query. Include this as an `export` to name it and make it accessible.
|
|
*/
|
|
export const internalQuery = internalQueryGeneric;
|
|
|
|
/**
|
|
* Define a mutation in this Convex app's public API.
|
|
*
|
|
* This function will be allowed to modify your Convex database and will be accessible from the client.
|
|
*
|
|
* @param func - The mutation function. It receives a {@link MutationCtx} as its first argument.
|
|
* @returns The wrapped mutation. Include this as an `export` to name it and make it accessible.
|
|
*/
|
|
export const mutation = mutationGeneric;
|
|
|
|
/**
|
|
* Define a mutation that is only accessible from other Convex functions (but not from the client).
|
|
*
|
|
* This function will be allowed to modify your Convex database. It will not be accessible from the client.
|
|
*
|
|
* @param func - The mutation function. It receives a {@link MutationCtx} as its first argument.
|
|
* @returns The wrapped mutation. Include this as an `export` to name it and make it accessible.
|
|
*/
|
|
export const internalMutation = internalMutationGeneric;
|
|
|
|
/**
|
|
* Define an action in this Convex app's public API.
|
|
*
|
|
* An action is a function which can execute any JavaScript code, including non-deterministic
|
|
* code and code with side-effects, like calling third-party services.
|
|
* They can be run in Convex's JavaScript environment or in Node.js using the "use node" directive.
|
|
* They can interact with the database indirectly by calling queries and mutations using the {@link ActionCtx}.
|
|
*
|
|
* @param func - The action. It receives an {@link ActionCtx} as its first argument.
|
|
* @returns The wrapped action. Include this as an `export` to name it and make it accessible.
|
|
*/
|
|
export const action = actionGeneric;
|
|
|
|
/**
|
|
* Define an action that is only accessible from other Convex functions (but not from the client).
|
|
*
|
|
* @param func - The function. It receives an {@link ActionCtx} as its first argument.
|
|
* @returns The wrapped function. Include this as an `export` to name it and make it accessible.
|
|
*/
|
|
export const internalAction = internalActionGeneric;
|
|
|
|
/**
|
|
* Define a Convex HTTP action.
|
|
*
|
|
* @param func - The function. It receives an {@link ActionCtx} as its first argument, and a `Request` object
|
|
* as its second.
|
|
* @returns The wrapped endpoint function. Route a URL path to this function in `convex/http.js`.
|
|
*/
|
|
export const httpAction = httpActionGeneric;
|