-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
67fe407
commit 3ffd826
Showing
13 changed files
with
530 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
# Welcome to your Convex functions directory! | ||
|
||
Write your Convex functions here. | ||
See https://docs.convex.dev/functions for more. | ||
|
||
A query function that takes two arguments looks like: | ||
|
||
```ts | ||
// functions.js | ||
import { query } from "./_generated/server"; | ||
import { v } from "convex/values"; | ||
|
||
export const myQueryFunction = query({ | ||
// Validators for arguments. | ||
args: { | ||
first: v.number(), | ||
second: v.string(), | ||
}, | ||
|
||
// Function implementation. | ||
handler: async (ctx, args) => { | ||
// Read the database as many times as you need here. | ||
// See https://docs.convex.dev/database/reading-data. | ||
const documents = await ctx.db.query("tablename").collect(); | ||
|
||
// Arguments passed from the client are properties of the args object. | ||
console.log(args.first, args.second); | ||
|
||
// Write arbitrary JavaScript here: filter, aggregate, build derived data, | ||
// remove non-public properties, or create new objects. | ||
return documents; | ||
}, | ||
}); | ||
``` | ||
|
||
Using this query function in a React component looks like: | ||
|
||
```ts | ||
const data = useQuery(api.functions.myQueryFunction, { | ||
first: 10, | ||
second: "hello", | ||
}); | ||
``` | ||
|
||
A mutation function looks like: | ||
|
||
```ts | ||
// functions.js | ||
import { mutation } from "./_generated/server"; | ||
import { v } from "convex/values"; | ||
|
||
export const myMutationFunction = mutation({ | ||
// Validators for arguments. | ||
args: { | ||
first: v.string(), | ||
second: v.string(), | ||
}, | ||
|
||
// Function implementation. | ||
handler: async (ctx, args) => { | ||
// Insert or modify documents in the database here. | ||
// Mutations can also read from the database like queries. | ||
// See https://docs.convex.dev/database/writing-data. | ||
const message = { body: args.first, author: args.second }; | ||
const id = await ctx.db.insert("messages", message); | ||
|
||
// Optionally, return a value from your mutation. | ||
return await ctx.db.get(id); | ||
}, | ||
}); | ||
``` | ||
|
||
Using this mutation function in a React component looks like: | ||
|
||
```ts | ||
const mutation = useMutation(api.functions.myMutationFunction); | ||
function handleButtonPress() { | ||
// fire and forget, the most common way to use mutations | ||
mutation({ first: "Hello!", second: "me" }); | ||
// OR | ||
// use the result once the mutation has completed | ||
mutation({ first: "Hello!", second: "me" }).then((result) => | ||
console.log(result), | ||
); | ||
} | ||
``` | ||
|
||
Use the Convex CLI to push your functions to a deployment. See everything | ||
the Convex CLI can do by running `npx convex -h` in your project root | ||
directory. To learn more, launch the docs with `npx convex docs`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
/* prettier-ignore-start */ | ||
|
||
/* eslint-disable */ | ||
/** | ||
* Generated `api` utility. | ||
* | ||
* THIS CODE IS AUTOMATICALLY GENERATED. | ||
* | ||
* To regenerate, run `npx convex dev`. | ||
* @module | ||
*/ | ||
|
||
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<{}>; | ||
export declare const api: FilterApi< | ||
typeof fullApi, | ||
FunctionReference<any, "public"> | ||
>; | ||
export declare const internal: FilterApi< | ||
typeof fullApi, | ||
FunctionReference<any, "internal"> | ||
>; | ||
|
||
/* prettier-ignore-end */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
/* prettier-ignore-start */ | ||
|
||
/* eslint-disable */ | ||
/** | ||
* Generated `api` utility. | ||
* | ||
* THIS CODE IS AUTOMATICALLY GENERATED. | ||
* | ||
* To regenerate, run `npx convex dev`. | ||
* @module | ||
*/ | ||
|
||
import { anyApi } from "convex/server"; | ||
|
||
/** | ||
* A utility for referencing Convex functions in your app's API. | ||
* | ||
* Usage: | ||
* ```js | ||
* const myFunctionReference = api.myModule.myFunction; | ||
* ``` | ||
*/ | ||
export const api = anyApi; | ||
export const internal = anyApi; | ||
|
||
/* prettier-ignore-end */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
/* prettier-ignore-start */ | ||
|
||
/* eslint-disable */ | ||
/** | ||
* Generated data model types. | ||
* | ||
* THIS CODE IS AUTOMATICALLY GENERATED. | ||
* | ||
* To regenerate, run `npx convex dev`. | ||
* @module | ||
*/ | ||
|
||
import { AnyDataModel } from "convex/server"; | ||
import type { GenericId } from "convex/values"; | ||
|
||
/** | ||
* No `schema.ts` file found! | ||
* | ||
* This generated code has permissive types like `Doc = any` because | ||
* Convex doesn't know your schema. If you'd like more type safety, see | ||
* https://docs.convex.dev/using/schemas for instructions on how to add a | ||
* schema file. | ||
* | ||
* After you change a schema, rerun codegen with `npx convex dev`. | ||
*/ | ||
|
||
/** | ||
* The names of all of your Convex tables. | ||
*/ | ||
export type TableNames = string; | ||
|
||
/** | ||
* The type of a document stored in Convex. | ||
*/ | ||
export type Doc = any; | ||
|
||
/** | ||
* An identifier for a document in Convex. | ||
* | ||
* Convex documents are uniquely identified by their `Id`, which is accessible | ||
* on the `_id` field. To learn more, see [Document IDs](https://docs.convex.dev/using/document-ids). | ||
* | ||
* Documents can be loaded using `db.get(id)` in query and mutation functions. | ||
* | ||
* IDs are just strings at runtime, but this type can be used to distinguish them from other | ||
* strings when type checking. | ||
*/ | ||
export type Id<TableName extends TableNames = TableNames> = | ||
GenericId<TableName>; | ||
|
||
/** | ||
* A type describing your Convex data model. | ||
* | ||
* This type includes information about what tables you have, the type of | ||
* documents stored in those tables, and the indexes defined on them. | ||
* | ||
* This type is used to parameterize methods like `queryGeneric` and | ||
* `mutationGeneric` to make them type-safe. | ||
*/ | ||
export type DataModel = AnyDataModel; | ||
|
||
/* prettier-ignore-end */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,146 @@ | ||
/* prettier-ignore-start */ | ||
|
||
/* 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 { | ||
ActionBuilder, | ||
HttpActionBuilder, | ||
MutationBuilder, | ||
QueryBuilder, | ||
GenericActionCtx, | ||
GenericMutationCtx, | ||
GenericQueryCtx, | ||
GenericDatabaseReader, | ||
GenericDatabaseWriter, | ||
} from "convex/server"; | ||
import type { DataModel } from "./dataModel.js"; | ||
|
||
/** | ||
* 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 declare const query: QueryBuilder<DataModel, "public">; | ||
|
||
/** | ||
* 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 declare const internalQuery: QueryBuilder<DataModel, "internal">; | ||
|
||
/** | ||
* 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 declare const mutation: MutationBuilder<DataModel, "public">; | ||
|
||
/** | ||
* 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 declare const internalMutation: MutationBuilder<DataModel, "internal">; | ||
|
||
/** | ||
* 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 declare const action: ActionBuilder<DataModel, "public">; | ||
|
||
/** | ||
* 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 declare const internalAction: ActionBuilder<DataModel, "internal">; | ||
|
||
/** | ||
* Define an HTTP action. | ||
* | ||
* This function will be used to respond to HTTP requests received by a Convex | ||
* deployment if the requests matches the path and method where this action | ||
* is routed. Be sure to route your action in `convex/http.js`. | ||
* | ||
* @param func - The function. It receives an {@link ActionCtx} as its first argument. | ||
* @returns The wrapped function. Import this function from `convex/http.js` and route it to hook it up. | ||
*/ | ||
export declare const httpAction: HttpActionBuilder; | ||
|
||
/** | ||
* A set of services for use within Convex query functions. | ||
* | ||
* The query context is passed as the first argument to any Convex query | ||
* function run on the server. | ||
* | ||
* This differs from the {@link MutationCtx} because all of the services are | ||
* read-only. | ||
*/ | ||
export type QueryCtx = GenericQueryCtx<DataModel>; | ||
|
||
/** | ||
* A set of services for use within Convex mutation functions. | ||
* | ||
* The mutation context is passed as the first argument to any Convex mutation | ||
* function run on the server. | ||
*/ | ||
export type MutationCtx = GenericMutationCtx<DataModel>; | ||
|
||
/** | ||
* A set of services for use within Convex action functions. | ||
* | ||
* The action context is passed as the first argument to any Convex action | ||
* function run on the server. | ||
*/ | ||
export type ActionCtx = GenericActionCtx<DataModel>; | ||
|
||
/** | ||
* An interface to read from the database within Convex query functions. | ||
* | ||
* The two entry points are {@link DatabaseReader.get}, which fetches a single | ||
* document by its {@link Id}, or {@link DatabaseReader.query}, which starts | ||
* building a query. | ||
*/ | ||
export type DatabaseReader = GenericDatabaseReader<DataModel>; | ||
|
||
/** | ||
* An interface to read from and write to the database within Convex mutation | ||
* functions. | ||
* | ||
* Convex guarantees that all writes within a single mutation are | ||
* executed atomically, so you never have to worry about partial writes leaving | ||
* your data in an inconsistent state. See [the Convex Guide](https://docs.convex.dev/understanding/convex-fundamentals/functions#atomicity-and-optimistic-concurrency-control) | ||
* for the guarantees Convex provides your functions. | ||
*/ | ||
export type DatabaseWriter = GenericDatabaseWriter<DataModel>; | ||
|
||
/* prettier-ignore-end */ |
Oops, something went wrong.