Skip to content

Commit ea51698

Browse files
authored
Apply suggestions from code review
1 parent 90eecc2 commit ea51698

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

docs/guide/application-side/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Forces your server to send a "loading" authentication status on all requests, th
6464

6565
- **Type**: `string | undefined`
6666

67-
The full url at which the app will run combined with the path to authentication. You should only use `baseURL` if you want to staticlly set a baseURL for your application.
67+
The full URL at which the app will run combined with the path to authentication. You should only use `baseURL` if you want to set it statically for your application.
6868

6969
You can read additional information on `origin` and `baseURL` determining [here](/resources/error-reference#auth-no-origin).
7070

docs/guide/local/quick-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export default defineNuxtConfig({
4444

4545
Each endpoint, consists of an object, with a `path` and `method`. When a user triggers an action inside your application a request will be made to each endpoint. When a request is made to the `getSession` endpoint, a token will be sent as a header. You can configure the headers and token below.
4646

47-
In the example above, we define a runtimeConfig value with the `baseURl` using the originEnvKey, which results in requests being made to the following urls:
47+
In the example above, we define a [runtime config](https://nuxt.com/docs/guide/going-further/runtime-config) value with the `baseURL` using the `originEnvKey`, which results in requests being made to the following URLs:
4848

4949
- **Sign in:** `/api/auth/login` (POST)
5050
- **Sign out** `/api/auth/logout` (POST)
@@ -78,7 +78,7 @@ You can also set your endpoints to query an external backend:
7878
export default defineNuxtConfig({
7979
// ...Previous configuration
8080
runtimeConfig: {
81-
baseURL: 'https://example-api.com'
81+
baseURL: 'https://example.com/api'
8282
},
8383
auth: {
8484
originEnvKey: 'NUXT_BASE_URL',

docs/upgrade/version-0.10.0.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ npm i -D @sidebase/nuxt-auth@^0.10.0
1111
```
1212

1313
```bash [pnpm]
14-
pnpm i -D @sidebase/nuxt-auth^0.10.0
14+
pnpm i -D @sidebase/nuxt-auth@^0.10.0
1515
```
1616

1717
```bash [yarn]
18-
yarn add --dev @sidebase/nuxt-auth^0.10.0
18+
yarn add --dev @sidebase/nuxt-auth@^0.10.0
1919
```
2020

2121
:::
@@ -86,9 +86,9 @@ NUXT_BASE_URL="https://my-backend.com/api/auth" // [!code ++]
8686

8787
### Adjustments when using an external backend for the `local`-provider
8888

89-
In previous versions of `@sidebase/nuxt-auth` a very specific setup was needed to ensure that external backends could properly be used for the `local`-provider. In 0.10.0 we reworked the internal handling or urls to make it more consistent across providers and configurations.
89+
In previous versions of `@sidebase/nuxt-auth` a very specific setup was needed to ensure that external backends could properly be used for the `local` provider. In 0.10.0 we reworked the internal handling or URLs to make it more consistent across providers and configurations.
9090

91-
If you were previously using an external backend you can now make the following adjustments:
91+
If you were previously using an external backend, you can now prefix endpoint paths with a `/`:
9292

9393
```ts diff
9494
export default defineNuxtConfig({
@@ -106,7 +106,7 @@ export default defineNuxtConfig({
106106
})
107107
```
108108

109-
You can find a full overview of how `@sidebase/nuxt-auth`handles urls [here](https://github.com/sidebase/nuxt-auth/pull/913#issuecomment-2359137989).
109+
You can find a full overview of how `@sidebase/nuxt-auth` handles URLs [here](https://github.com/sidebase/nuxt-auth/pull/913#issuecomment-2359137989) and in spec files for [`authjs` provider](https://github.com/sidebase/nuxt-auth/blob/main/tests/authjs.url.spec.ts) and [`local` provider](https://github.com/sidebase/nuxt-auth/blob/main/tests/local.url.spec.ts).
110110

111111
## Changelog
112112

0 commit comments

Comments
 (0)