dillonkearns/elm-pages-v3-beta
1
1
Fork 0
mirror of https://github.com/dillonkearns/elm-pages-v3-beta.git synced 2024-12-25 04:43:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

Remove obsolete section and rename.

Browse Source
This commit is contained in:
Dillon Kearns 2023-03-14 16:17:28 -07:00
parent 28d1944ef2
commit 0eceb60fee
1 changed files with 1 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
examples/docs/content/docs/07-data-sources.md → examples/docs/content/docs/07-backend-tasks.md
View File

@ -1,5 +1,5 @@
---
description: TODO
description: Understanding BackendTasks
---
# `BackendTask`s
@ -71,29 +71,3 @@ That means that when we run `elm-pages build`, then deploy the HTML and JSON out
So when a user goes to your site, they won't hit your CMS directly. Instead, when they load the page it will include all of the data that we used for that specific page
in the initial load. That's how `elm-pages` can skip the loading spinner for an HTTP data source - it builds the data into the page at build-time.
## Optimized Decoders
Often REST APIs will include a lot of data that you can use. But you might need just a couple of fields.
When you write an `OptimizedDecoder`, `elm-pages` will only include the JSON data that you decoded when it builds that page.
For example, the GitHub API returns back dozens of fields in this API response, but we only want one: the number of stargazers.
```elm
import OptimizedDecoder
import BackendTask exposing (BackendTask)
staticData : BackendTask Int
staticData =
BackendTask.Http.get (Secrets.succeed "https://api.github.com/repos/dillonkearns/elm-pages")
(OptimizedDecoder.field "stargazers_count" OptimizedDecoder.int)
```
That means the data that gets built into the site will be:
```json
{ "stargazers_count": 123 }
```
At build-time, `elm-pages` performs this optimization, which means your users don't have to pay the cost of running it when your site loads in their browser - they get the best of both worlds with a smaller JSON payload, and a fast decoder!