docs: server functions #2722
Merged
docs: server functions #2722
+2,218
−1,448
Conversation
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
|
|
Deploying with
|
| Latest commit: |
e50ead3
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://2c517300.qwik-docs.pages.dev |
| Branch Preview URL: | https://server-fn-docs.qwik-docs.pages.dev |
VinSpee
reviewed
Jan 27, 2023
|
|
||
| ```tsx | ||
| export const onGet: RequestHandler = async ({ json }) => { | ||
| throw json(200, { hello: 'world' }); |
There was a problem hiding this comment.
Is the new syntax to actually throw each of these (text, json, etc?)
VinSpee
suggested changes
Jan 27, 2023
|
|
||
| Loaders allow data to flow from the server to the Qwik Components. For this reason, Qwik Loaders should be always understood in the context of **loading data in the server that is later consumed by a Qwik Component**, if you want to create a RESTful endpoint, please check the [endpoints](/guide/endpoints) guide instead. | ||
|
|
||
| The behave like RPC server-side functions that can be invokated by Qwik Components during rendering. |
There was a problem hiding this comment.
Suggested change
| The behave like RPC server-side functions that can be invokated by Qwik Components during rendering. | |
| They behave like RPC server-side functions that can be invoked by Qwik Components during rendering. |
|
|
||
| ## Using a loader | ||
|
|
||
| Loaders are consumed using the `.use()` method from within a Qwik Component. The `use()` return a `Signal` which value is the data returned by the loader function. |
There was a problem hiding this comment.
Suggested change
| Loaders are consumed using the `.use()` method from within a Qwik Component. The `use()` return a `Signal` which value is the data returned by the loader function. | |
| Loaders are consumed using the `.use()` method from within a Qwik Component. `use()` returns a `Signal` with the data returned by the loader function as it’s value. |
| }); | ||
| ``` | ||
|
|
||
| > The `.use()` retrives the loader data, but it does not execute the loader multiple times. Loaders execute eagarly at the beginning of the request in order to provide low latency. For this reason they are only allowed in the `src/routes` folder, in a `layout.tsx` or `index.tsx` file, and they MUST be exported. |
There was a problem hiding this comment.
Suggested change
| > The `.use()` retrives the loader data, but it does not execute the loader multiple times. Loaders execute eagarly at the beginning of the request in order to provide low latency. For this reason they are only allowed in the `src/routes` folder, in a `layout.tsx` or `index.tsx` file, and they MUST be exported. | |
| > `.use()` retrieves the loader data, but it does not execute the loader multiple times. Loaders execute eagerly, at the beginning of the request, in order to provide low latency. For this reason they are only allowed in the `src/routes` folder, in a `layout.tsx` or `index.tsx` file, and they MUST be exported. |
|
|
||
| ## Loader context | ||
|
|
||
| Just like request handlers such as `onRequest` and `onGet`, loaders have access to the `RequestEvent` object, that includes information about the current request. |
There was a problem hiding this comment.
Suggested change
| Just like request handlers such as `onRequest` and `onGet`, loaders have access to the `RequestEvent` object, that includes information about the current request. | |
| Just like request handlers such as `onRequest` and `onGet`, loaders have access to the `RequestEvent` object which includes information about the current request. |
|
|
||
| Just like request handlers such as `onRequest` and `onGet`, loaders have access to the `RequestEvent` object, that includes information about the current request. | ||
|
|
||
| This information comes handly when the loaders needs to conditionally return data based on the request, or it needs to override the response status, headers or body manually. |
There was a problem hiding this comment.
Suggested change
| This information comes handly when the loaders needs to conditionally return data based on the request, or it needs to override the response status, headers or body manually. | |
| This information comes in handy when the loader needs to conditionally return data based on the request, or it needs to override the response status, headers or body manually. |
|
|
||
| A loader should be used when you need to provide some server-side data to your Qwik Components. For example, if you need to fetch some data from a database or an API, you can use a loader to do that. | ||
|
|
||
| You should not use a loader to create a REST API, for that you better use a [Endpoint](/qwik-city/), which allows you to have tight control over the response headers and body. |
There was a problem hiding this comment.
Suggested change
| You should not use a loader to create a REST API, for that you better use a [Endpoint](/qwik-city/), which allows you to have tight control over the response headers and body. | |
| You should not use a loader to create a REST API, for that you’d be better off using an [Endpoint](/qwik-city/), which allows you to have tight control over the response headers and body. |
|
Thanks for the review! unfortunately i am moving so many things, i cant apply the feedback! |
This was referenced Jan 27, 2023
literalpie
reviewed
Jan 29, 2023
Futhark
reviewed
Feb 4, 2023
|
|
||
| Loaders allow data to flow from the server to the Qwik Components. For this reason, Qwik Loaders should be always understood in the context of **loading data in the server that is later consumed by a Qwik Component**, if you want to create a RESTful endpoint, please check the [endpoints](/qwikcity/endpoints/index.mdx) guide instead. | ||
|
|
||
| The behave like RPC server-side functions that can be invokated by Qwik Components during rendering. |
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.