docs: clarify query.batch example variable naming #15282
Conversation
|
RazinShafayet2007
changed the title
|
|
||
| export const getWeather = query.batch(v.string(), async (cities) => { | ||
| export const getWeather = query.batch(v.string(), async (cityIds) => { | ||
| const weather = await db.sql` |
There was a problem hiding this comment.
Should this be weathers to clarify that it is an array?
There was a problem hiding this comment.
Good point. I was just focused on cities → cityIds and city → cityId. To make it clearer that the SQL result is an array, I’ll rename weather to weatherData.
|
Closing since this also renamed all the |
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
| ``` | ||
|
|
||
| > [!NOTE] The preflight schema can be the same object as your server-side schema, if appropriate, though it won't be able to do server-side checks like 'this value already exists in the database'. Note that you cannot export a schema from a `.remote.ts` or `.remote.js` file, so the schema must either be exported from a shared module, or from a `<script module>` block in the component containing the `<form>`. | ||
| > [!NOTE] The preflight schema can be the same object as your server-side schema, if appropriate, though it won't be able to do server-side checks like 'this value already exists in the database'. Note that you cannot export a schema from a `.ts` or `.js` file, so the schema must either be exported from a shared module, or from a `<script module>` block in the component containing the `<form>`. |
There was a problem hiding this comment.
| > [!NOTE] The preflight schema can be the same object as your server-side schema, if appropriate, though it won't be able to do server-side checks like 'this value already exists in the database'. Note that you cannot export a schema from a `.ts` or `.js` file, so the schema must either be exported from a shared module, or from a `<script module>` block in the component containing the `<form>`. | |
| > [!NOTE] The preflight schema can be the same object as your server-side schema, if appropriate, though it won't be able to do server-side checks like 'this value already exists in the database'. Note that you cannot export a schema from a `.remote.ts` or `.remote.js` file, so the schema must either be exported from a shared module, or from a `<script module>` block in the component containing the `<form>`. |
Documentation note incorrectly states schemas cannot be exported from any .ts or .js file, when the restriction is specific to .remote.ts or .remote.js files
|
|
||
| ```js | ||
| /// file: data.remote.js | ||
| /// file: data.js |
There was a problem hiding this comment.
Multiple server-side file examples in the form/Fields section incorrectly use data.js and src/routes/shop/data.js extensions instead of the required data.remote.js and src/routes/shop/data.remote.js extensions
| ```svelte | ||
| <script> | ||
| import { createProfile } from './data.remote'; | ||
| import { createProfile } from './data'; |
There was a problem hiding this comment.
Documentation contains inconsistent import statements that omit the .remote extension, contradicting the stated file naming convention.
3 participants
Fixes #15278
This PR clarifies the
query.batchexample in the Remote Functions documentation.The previous example used the variable names
citiesandcity, which made it unclear that the inputs are actually string IDs (for example,city.id), not city objects or names. This ambiguity can be confusing, especially for readers new toquery.batch.The example has been updated with clearer, more explicit naming:
cities→cityIdscity→cityIdThe SQL query and lookup map were also adjusted to use
city_id, aligning the example with common database schemas and making it consistent with how the data is consumed in the accompanying component.Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
Tests
pnpm testand lint the project withpnpm lintandpnpm checkChangesets
pnpm changesetand following the prompts. Changesets that add features should beminorand those that fix bugs should bepatch. Please prefix changeset messages withfeat:,fix:, orchore:.Edits