Skip to content

docs: say where createSvelteAuthClient's client options take effect - #53

Merged
mmailaender merged 1 commit into
mainfrom
docs/client-options-jsdoc
Oct 15, 2026
Merged

mmailaender merged 1 commit into
mainfrom
docs/client-options-jsdoc

Conversation

@mmailaender

Copy link
Copy Markdown
Owner

Summary

  • JSDoc for createSvelteAuthClient({ options }): says when the Convex client options take effect, and where to pass them otherwise.
  • No behavior change. Comment only, so no changeset.
  • Part of 0.10.0.

Why

In the SvelteKit SSR setup, initConvex() in src/hooks.ts creates the Convex client, and setupConvex() reuses it. So options passed to createSvelteAuthClient have always been ignored there, silently. convex-svelte 0.15.1 (convex/convex-svelte#62) adds a dev warning for this. The option itself had no doc saying so.

What

/**
 * Options for the `ConvexClient` this creates. Ignored when `convexClient`
 * is passed, or when `initConvex()` from `convex-svelte/sveltekit` already
 * created the client: pass them to `initConvex()` instead.
 */
options?: ConvexClientOptions;

@mmailaender
mmailaender marked this pull request as ready for review October 15, 2026 05:53
@mmailaender
mmailaender merged commit 0b18ffd into main Oct 15, 2026
2 checks passed
@mmailaender
mmailaender deleted the docs/client-options-jsdoc branch October 15, 2026 05:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant