Runtime types do not match documentation - Githubissues

sidebase / nuxt-auth

Authentication built for Nuxt 3! Easily add authentication via OAuth providers, credentials or Email Magic URLs!

https://auth.sidebase.io

MIT License

1.31k stars 164 forks source link

Runtime types do not match documentation #830

Closed dc-shackle closed 2 months ago

dc-shackle commented 3 months ago

Describe the feature

Wasn't sure if this counts as a bug report or enhancement as it touches on both documentation and code.

https://github.com/sidebase/nuxt-auth/blob/9295d1fe4f27d42c879862a48202f5b215fc0048/src/runtime/types.ts#L84-L96

The signIn and signUp endpoints do not allow for a value of false to be provided, though the documentation implies that it should be possible to do so (https://auth.sidebase.io/guide/local/quick-start#api-endpoints).

How would you implement this?

Update the runtime types mentioned to allow for a value of false.

Additional information

[ ] Would you be willing to help implement this feature?

Provider

[ ] AuthJS
[X] Local
[X] Refresh
[ ] New Provider

zoey-kaiser commented 2 months ago

Hi @dc-shackle 👋

We resolved this issue in the rewrite of the documentation. Thank you very much for brining it up 😊