Skip to content

Commit

Permalink
fix(docs): fix quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
enkot committed Oct 13, 2023
1 parent de00864 commit 362d724
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Generate zero-overhead, 100% typed OpenAPI clients for Nuxt.
In other words - `$fetch` and `useFetch` on steroids. Uses awesome [openapi-typescript](https://github.com/drwpow/openapi-typescript) generator under the hood.

> ⚠️ APIs are subject to change.
> I'd love to hear any ideas/suggestions/improvements! :)
> All ideas/suggestions are welcome! :)

- [ Release Notes](/CHANGELOG.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/content/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Nuxt [Open]{style="color: var(--color-primary-400)"} Fetch
Generate zero-overhead, 100% typed [OpenAPI](https://www.openapis.org/) clients for [Nuxt](https://nuxt.com).

> ⚠️ APIs are subject to change.
> I'd love to hear any ideas/suggestions! :)
> All ideas/suggestions are welcome! :)
#extra
::list
Expand Down
10 changes: 5 additions & 5 deletions docs/content/1.setup/1.quick-start.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Quick start

**NuxtOpenFetchsd** creates zero-overhead wrappers around `$fetch` and `useFetch`, with types generated from your [OpenAPI](https://www.openapis.org/) schema.
**NuxtOpenFetch** creates zero-overhead wrappers around `$fetch` and `useFetch`, with types generated from your [OpenAPI](https://www.openapis.org/) schema.
It uses awesome [openapi-typescript](https://github.com/drwpow/openapi-typescript) generator under the hood.

## Installation
Expand Down Expand Up @@ -57,15 +57,15 @@ nuxt.config.ts
```vue
<script setup lang="ts">
const { data, error } = await usePetsFetch('/pet/{petId}', {
params: computed(() => ({
petId: id.value
}))
path: {
petId
}
})
// or
const data = await $petsFetch('/pet/{petId}', {
params: {
path: {
petId
}
})
Expand Down

0 comments on commit 362d724

Please sign in to comment.