Skip to content

docs: clean up the serverFunctions.onError JSDoc - #2266

Merged
birkskyum merged 2 commits into
solidjs:mainfrom
adipascu:docs/server-fn-error-handler-jsdoc
Jul 29, 2026
Merged

docs: clean up the serverFunctions.onError JSDoc#2266
birkskyum merged 2 commits into
solidjs:mainfrom
adipascu:docs/server-fn-error-handler-jsdoc

Conversation

@adipascu

@adipascu adipascu commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

  • Addresses an existing open issue: fixes #000
  • Tests for the changes have been added (for bug fixes / features)

What is the current behavior?

Cleanup of my own JSDoc from #2262. serverFunctions.onError is documented too thinly to write a handler from, and ServerFunctionErrorHandler has no doc at all.

What is the new behavior?

Behavior unchanged, documentation only. The option now states that:

  • a thrown Response reaches the handler, so replacing everything breaks redirect()
  • the return value is not awaited
  • only calls arriving over /_server reach it

ServerFunctionErrorHandler gets @param, @returns, and an @example, and the inert /** @internal */ is dropped.

Other information

Comments only, so no tests and no changeset.

Paired with solidjs/solid-docs#1610, which expands the config reference page for this option.

@netlify

netlify Bot commented Jul 29, 2026

Copy link
Copy Markdown

Deploy Preview for solid-start-landing-page ready!

Name Link
🔨 Latest commit 70e6578
🔍 Latest deploy log https://app.netlify.com/projects/solid-start-landing-page/deploys/6a6a26284afa800008a75325
😎 Deploy Preview https://deploy-preview-2266--solid-start-landing-page.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@changeset-bot

changeset-bot Bot commented Jul 29, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 70e6578

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@pkg-pr-new

pkg-pr-new Bot commented Jul 29, 2026

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@solidjs/start@2266

commit: 70e6578

@adipascu
adipascu force-pushed the docs/server-fn-error-handler-jsdoc branch from b1d3914 to 3b80c45 Compare July 29, 2026 15:10
@adipascu
adipascu marked this pull request as draft July 29, 2026 15:15
@adipascu
adipascu force-pushed the docs/server-fn-error-handler-jsdoc branch from 3b80c45 to b695aa0 Compare July 29, 2026 15:35
@adipascu adipascu changed the title docs: document the serverFunctions.onError contract docs: expand the serverFunctions.onError JSDoc Jul 29, 2026
@adipascu
adipascu force-pushed the docs/server-fn-error-handler-jsdoc branch from b695aa0 to cbe53fc Compare July 29, 2026 15:37
@adipascu adipascu changed the title docs: expand the serverFunctions.onError JSDoc docs: clean up the serverFunctions.onError JSDoc Jul 29, 2026
@adipascu
adipascu force-pushed the docs/server-fn-error-handler-jsdoc branch 6 times, most recently from 6f3d6b2 to 193ade1 Compare July 29, 2026 15:53
@adipascu
adipascu marked this pull request as ready for review July 29, 2026 15:54
Comment thread packages/start/src/fns/error-handler.ts
@adipascu
adipascu force-pushed the docs/server-fn-error-handler-jsdoc branch 2 times, most recently from bdd75e3 to 7a73d80 Compare July 29, 2026 16:01
@adipascu
adipascu force-pushed the docs/server-fn-error-handler-jsdoc branch from 7a73d80 to 7ff638e Compare July 29, 2026 16:02
@birkskyum
birkskyum merged commit 5a0015b into solidjs:main Jul 29, 2026
11 checks passed
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.

2 participants