Skip to content

docs: shorten createServerClient tsdoc#174

Open
mandarini wants to merge 2 commits intomainfrom
docs/shorten-tsdoc
Open

docs: shorten createServerClient tsdoc#174
mandarini wants to merge 2 commits intomainfrom
docs/shorten-tsdoc

Conversation

@mandarini
Copy link
Contributor

@mandarini mandarini commented Mar 11, 2026

Make more concise the createServerClient tsdoc, so it's not repetitive, but still conveys the full information needed.

@coderabbitai
Copy link

coderabbitai bot commented Mar 11, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 262a428d-e40b-4a0d-ba9f-329c00a2e47c

📥 Commits

Reviewing files that changed from the base of the PR and between 885f227 and 96d75ff.

📒 Files selected for processing (1)
  • src/createServerClient.ts

📝 Walkthrough

Summary by CodeRabbit

  • API Changes

    • Updated the primary createServerClient method signature requiring a modern cookie implementation.
    • Secondary method overload maintains backward compatibility with legacy cookie implementations.
  • Documentation

    • Simplified middleware guidance and session handling instructions for clarity.

Walkthrough

The createServerClient function type signatures in src/createServerClient.ts have been updated to enforce stricter typing on the primary overload. The first overload now requires cookies: CookieMethodsServer instead of the deprecated CookieMethodsServerDeprecated. A secondary overload retains backward compatibility by accepting cookies: CookieMethodsServer | CookieMethodsServerDeprecated. Documentation blocks were consolidated and simplified regarding middleware guidance, error messaging, and session handling. No runtime behavioral changes were introduced; modifications are limited to public type signatures and accompanying documentation.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@mandarini mandarini marked this pull request as ready for review March 11, 2026 09:20
@mandarini mandarini self-assigned this Mar 11, 2026
@mandarini mandarini requested a review from fadymak March 11, 2026 10:40
Copilot AI review requested due to automatic review settings March 18, 2026 13:06
@mandarini mandarini force-pushed the docs/shorten-tsdoc branch from 96d75ff to e9a41fa Compare March 18, 2026 13:06
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the createServerClient JSDoc to simplify and clarify SSR usage guidance, especially around middleware vs. page/route usage and cookie method configuration.

Changes:

  • Condenses middleware guidance and clarifies that cookies.getAll/cookies.setAll are the recommended configuration (with deprecated methods being phased out).
  • Rewords page/component/route guidance around when setAll can be omitted and when middleware is required.
  • Simplifies the session initialization / token refresh explanation and its interaction with cookie writes.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@mandarini mandarini requested a review from fadymak March 18, 2026 13:52
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.

3 participants