mirror of
https://github.com/BradNut/gQuery
synced 2025-09-08 17:40:18 +00:00
updates read me
This commit is contained in:
parent
56059c8cce
commit
dae849234d
2 changed files with 59 additions and 1 deletions
60
README.md
60
README.md
|
|
@ -1,3 +1,5 @@
|
||||||
|

|
||||||
|
|
||||||
# qQuery
|
# qQuery
|
||||||
|
|
||||||
## Not like jQuery. A GraphQL Fetcher & Cache for Svelte Kit
|
## Not like jQuery. A GraphQL Fetcher & Cache for Svelte Kit
|
||||||
|
|
@ -8,11 +10,57 @@ More information in this space soon. API is very much in flux rn.
|
||||||
|
|
||||||
### Preview
|
### Preview
|
||||||
|
|
||||||
|
## 🪄 Magic Mode
|
||||||
|
|
||||||
|
Magic mode is the preferred way of using gQuery. Not because it's magical, but because it's easy.
|
||||||
|
|
||||||
|
### 1. Initialize G
|
||||||
|
|
||||||
|
```
|
||||||
|
export const g = new GFetch({
|
||||||
|
path: Environment.apiURL //whatever your api url is here
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Add GraphQL Codegen Plugin
|
||||||
|
|
||||||
|
docs coming soon
|
||||||
|
|
||||||
|
### 3. Run GraphQL Codegen
|
||||||
|
|
||||||
|
docs coming soon
|
||||||
|
|
||||||
|
### 4. Use that thang
|
||||||
|
|
||||||
|
```
|
||||||
|
<script context="module" lang="ts">
|
||||||
|
import { getSeriesList } from '../whatever'
|
||||||
|
|
||||||
|
export async function load() {
|
||||||
|
await getSeriesList({
|
||||||
|
limit: 0
|
||||||
|
})
|
||||||
|
return {}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<script lang="ts">
|
||||||
|
import { gCache } from '@leveluptuts/gQuery'
|
||||||
|
|
||||||
|
// $: console.log($gCache.seriesList)
|
||||||
|
</script>
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## Manual Mode
|
||||||
|
|
||||||
|
I guess if you want to do it this way you can.
|
||||||
|
|
||||||
## gFetch
|
## gFetch
|
||||||
|
|
||||||
The graphql fetcher client.
|
The graphql fetcher client.
|
||||||
|
|
||||||
Initialize
|
### 1. Initialize
|
||||||
|
|
||||||
```
|
```
|
||||||
export const g = new GFetch({
|
export const g = new GFetch({
|
||||||
|
|
@ -59,3 +107,13 @@ Use
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## FAQ / WTF
|
||||||
|
|
||||||
|
### Q? How tf do I update the cache?
|
||||||
|
|
||||||
|
It's a Svelte Writable Store. So after a mutation you can quickly and easily manually update the cache.
|
||||||
|
|
||||||
|
### Q? Can't you update the cache magically for me?
|
||||||
|
|
||||||
|
Maybe? If you want to be in charge of writing that bit, the door is open 😼
|
||||||
|
|
|
||||||
BIN
gQuery.png
Normal file
BIN
gQuery.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
Loading…
Reference in a new issue