Skip to content

Add documentation for custom class serialization - #810

Merged
TooTallNate merged 8 commits into
mainfrom
01-19-add_documentation_for_custom_class_serialization
Mar 18, 2026
Merged

Add documentation for custom class serialization#810
TooTallNate merged 8 commits into
mainfrom
01-19-add_documentation_for_custom_class_serialization

Conversation

@TooTallNate

@TooTallNateTooTallNate commented Jan 19, 2026•
edited
Loading

Copy link
Copy Markdown
Member

Added documentation for custom class serialization in workflows with new @workflow/serde package.

What changed?

  • Added documentation for the new @workflow/serde package that provides serialization symbols for custom class serialization
  • Added a new section to the serialization docs explaining how to make custom classes serializable
  • Added the @workflow/serde package to the API reference navigation
  • Updated the docs-typecheck extractor to support MDX comments for expect-error annotations

Why make this change?

Custom class serialization is an important feature for workflows that need to work with complex data structures. This documentation explains how developers can make their own classes serializable using the WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols from the new @workflow/serde package, enabling seamless passing of class instances between workflow and step functions.

@changeset-bot

changeset-botBot commented Jan 19, 2026•
edited
Loading

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 9830710

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

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

Not sure what this means? Click here to learn what changesets are.

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

@github-actions

github-actionsBot commented Jan 19, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

🧪 E2E Test Results

❌ Some tests failed

Summary

PassedFailedSkippedTotal
✅ ▲ Vercel Production758067825
✅ 💻 Local Development7820118900
✅ 📦 Local Production7820118900
✅ 🐘 Local Postgres7820118900
✅ 🪟 Windows720375
❌ 🌍 Community Worlds1185615189
✅ 📋 Other198027225
Total3492564664014

❌ Failed Tests

🌍 Community Worlds (56 failed)

mongodb (3 failed):

  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously

redis (2 failed):

  • hookWorkflow is not resumable via public webhook endpoint
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously

turso (51 failed):

  • addTenWorkflow
  • addTenWorkflow
  • wellKnownAgentWorkflow (.well-known/agent)
  • should work with react rendering in step
  • promiseAllWorkflow
  • promiseRaceWorkflow
  • promiseAnyWorkflow
  • importedStepOnlyWorkflow
  • hookWorkflow
  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • sleepingWorkflow
  • parallelSleepWorkflow
  • nullByteWorkflow
  • workflowAndStepMetadataWorkflow
  • fetchWorkflow
  • promiseRaceStressTestWorkflow
  • error handling error propagation workflow errors nested function calls preserve message and stack trace
  • error handling error propagation workflow errors cross-file imports preserve message and stack trace
  • error handling error propagation step errors basic step error preserves message and stack trace
  • error handling error propagation step errors cross-file step error preserves message and function names in stack
  • error handling retry behavior regular Error retries until success
  • error handling retry behavior FatalError fails immediately without retries
  • error handling retry behavior RetryableError respects custom retryAfter delay
  • error handling retry behavior maxRetries=0 disables retries
  • error handling catchability FatalError can be caught and detected with FatalError.is()
  • hookCleanupTestWorkflow - hook token reuse after workflow completion
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
  • hookDisposeTestWorkflow - hook token reuse after explicit disposal while workflow still running
  • stepFunctionPassingWorkflow - step function references can be passed as arguments (without closure vars)
  • stepFunctionWithClosureWorkflow - step function with closure variables passed as argument
  • closureVariableWorkflow - nested step functions with closure variables
  • spawnWorkflowFromStepWorkflow - spawning a child workflow using start() inside a step
  • health check (queue-based) - workflow and step endpoints respond to health check messages
  • pathsAliasWorkflow - TypeScript path aliases resolve correctly
  • Calculator.calculate - static workflow method using static step methods from another class
  • AllInOneService.processNumber - static workflow method using sibling static step methods
  • ChainableService.processWithThis - static step methods using this to reference the class
  • thisSerializationWorkflow - step function invoked with .call() and .apply()
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • stepFunctionAsStartArgWorkflow - step function reference passed as start() argument
  • cancelRun - cancelling a running workflow
  • cancelRun via CLI - cancelling a running workflow
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router
  • hookWithSleepWorkflow - hook payloads delivered correctly with concurrent sleep
  • sleepInLoopWorkflow - sleep inside loop with steps actually delays each iteration
  • sleepWithSequentialStepsWorkflow - sequential steps work with concurrent sleep (control)

Details by Category

✅ ▲ Vercel Production
AppPassedFailedSkipped
✅ astro6807
✅ example6807
✅ express6807
✅ fastify6807
✅ hono6807
✅ nextjs-turbopack7302
✅ nextjs-webpack7302
✅ nitro6807
✅ nuxt6807
✅ sveltekit6807
✅ vite6807
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack7203
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev302
❌ mongodb5233
✅ redis-dev302
❌ redis5323
✅ turso-dev302
❌ turso4513
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable6609
✅ e2e-local-postgres-nest-stable6609
✅ e2e-local-prod-nest-stable6609

📋 View full workflow run

This was referenced Jan 19, 2026
Merged
Merged
Merged
@TooTallNateGraphite App

TooTallNate commented Jan 19, 2026•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

This stack of pull requests is managed by Graphite. Learn more about stacking.

This was referenced Jan 19, 2026
Merged
Merged
@TooTallNate
TooTallNate marked this pull request as ready for review January 19, 2026 23:18
CopilotAI review requested due to automatic review settings January 19, 2026 23:18
@TooTallNate
TooTallNate marked this pull request as draft January 19, 2026 23:18
@vercel

vercelBot commented Jan 19, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

ProjectDeploymentActionsUpdated (UTC)
example-nextjs-workflow-turbopackReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
example-nextjs-workflow-webpackReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
example-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-astro-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-express-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-fastify-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-hono-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-nitro-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-nuxt-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-sveltekit-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-vite-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-docsReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-nestReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-swc-playgroundReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm

@TooTallNate
TooTallNateforce-pushed the 01-19-add_documentation_for_custom_class_serialization branch from cbe3550 to 9020264CompareJanuary 19, 2026 23:19
CopilotAI reviewed Jan 19, 2026
View reviewed changes

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

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 adds comprehensive documentation for the custom class serialization feature using the new @workflow/serde package. The documentation explains how developers can make their custom classes serializable in workflows by implementing WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols.

Changes:

  • Added a new "Custom Class Serialization" section to the serialization documentation with examples showing basic and complex usage patterns
  • Updated the docs-typecheck extractor to support MDX-style comments for @expect-error annotations in addition to HTML comments
  • Added the @workflow/serde package to the API reference navigation and index

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

Show a summary per file
FileDescription
packages/docs-typecheck/src/extractor.tsEnhanced regex to support both HTML and MDX comment formats for @expect-error annotations
docs/content/docs/foundations/serialization.mdxAdded comprehensive documentation section explaining custom class serialization with code examples
docs/content/docs/api-reference/meta.jsonAdded workflow-serde to the API reference pages list
docs/content/docs/api-reference/index.mdxAdded Card component linking to the @workflow/serde package documentation
.changeset/smooth-nails-do.mdEmpty changeset file (acceptable for documentation-only changes)

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

@TooTallNate
TooTallNateforce-pushed the 01-19-add_documentation_for_custom_class_serialization branch from 199d665 to feb442fCompareMarch 10, 2026 21:27
@TooTallNate
Merge branch 'main' into 01-19-add_documentation_for_custom_class_ser…
a039439
…ialization
@TooTallNate
Merge branch 'main' of github.com:vercel/workflow into 01-19-add_docu…
1e6ec66
…mentation_for_custom_class_serialization
@TooTallNate
Enhance serialization docs: custom class examples with 'use step' ins…
7bf8785
…tance methods
- Add custom classes to Supported Serializable Types with anchor link
- Replace verbose parenthetical in Requirements with back-link
- Add [!code highlight] to Basic Example serde methods
- Simplify geometry.ts to import Point instead of redefining it
- Rewrite Complex Example to demonstrate 'use step' on instance methods
with realistic APIs (database, HTTP) and contrast with workflow-context methods
- Add pass-by-value note for 'this' context with return-and-reassign pattern
@TooTallNate
Fix docs typecheck: use correct @expect-error codes for Order examples
2946474
@TooTallNate
Fix pre-existing docs typecheck failures in workflow-serde API reference
81c671e
Add @skip-typecheck to bare static method signatures that aren't valid
standalone TypeScript.
VaguelySerious
VaguelySerious approved these changes Mar 17, 2026
View reviewed changes
Comment threadpackages/docs-typecheck/src/extractor.ts
const CODE_BLOCK_REGEX =
/```(typescript|ts|javascript|js)(?:[^\S\n]+[^\n]*)?\n([\s\S]*?)```/g;
const EXPECT_ERROR_REGEX = /<!--\s*@expect-error:([0-9,\s]+)\s*-->/;
// Support both HTML comments (<!-- @expect-error:2351 -->) and MDX comments ({/* @expect-error:2351 */})

@VaguelySeriousVaguelySeriousMar 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

what is this change for?

@TooTallNateTooTallNateMar 17, 2026

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

The @expect-error marker only supported HTML comment syntax (<!-- @expect-error:2351 -->), which was sufficient since the only prior usage was in a .md file (the docs-typecheck README). However, MDX files do not support HTML comments — the MDX parser rejects <!-- with "Unexpected character !". Since the serialization docs are .mdx files and need @expect-error markers, this adds support for the MDX comment syntax ({/* @expect-error:2351 */}) as an alternative. The @skip-typecheck marker already supported both formats.

@TooTallNate
Revert extractor changes, use HTML comments for @expect-error markers
330ebcf
The docs typecheck extractor only supports HTML comment syntax for
@expect-error on main. Use <!-- @expect-error:XXXX --> instead of
{/* @expect-error:XXXX */} to match the existing convention.
@TooTallNate
Use MDX comment syntax for @expect-error markers, add MDX support to …
9830710
…extractor
MDX files don't support HTML comments (<!-- -->). The extractor's
@expect-error regex only supported HTML syntax, but @skip-typecheck
already supported both. This aligns @expect-error to also support
the MDX comment syntax ({/* @expect-error:XXXX */}).
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code reviewCopilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@VaguelySeriousVaguelySeriousVaguelySerious approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@TooTallNate@VaguelySerious
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add documentation for custom class serialization by TooTallNate · Pull Request #810 · vercel/workflow · GitHub
Skip to content
Add documentation for custom class serialization - #810
Merged
TooTallNate merged 8 commits into
mainfrom 
01-19-add_documentation_for_custom_class_serialization
Mar 18, 2026
Merged
Add documentation for custom class serialization#810
TooTallNate merged 8 commits into
mainfrom 
01-19-add_documentation_for_custom_class_serialization
Conversation
@TooTallNate
@TooTallNateTooTallNate
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Member
Added documentation for custom class serialization in workflows with new @workflow/serde package.
What changed?
  • Added documentation for the new @workflow/serde package that provides serialization symbols for custom class serialization
  • Added a new section to the serialization docs explaining how to make custom classes serializable
  • Added the @workflow/serde package to the API reference navigation
  • Updated the docs-typecheck extractor to support MDX comments for expect-error annotations
Why make this change?
Custom class serialization is an important feature for workflows that need to work with complex data structures. This documentation explains how developers can make their own classes serializable using the WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols from the new @workflow/serde package, enabling seamless passing of class instances between workflow and step functions.
@changeset-bot
changeset-botBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 9830710
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@github-actions
github-actionsBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
🧪 E2E Test Results
❌ Some tests failed
Summary
PassedFailedSkippedTotal
✅ ▲ Vercel Production758067825
✅ 💻 Local Development7820118900
✅ 📦 Local Production7820118900
✅ 🐘 Local Postgres7820118900
✅ 🪟 Windows720375
❌ 🌍 Community Worlds1185615189
✅ 📋 Other198027225
Total3492564664014
❌ Failed Tests
🌍 Community Worlds (56 failed)
mongodb (3 failed):
  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
redis (2 failed):
  • hookWorkflow is not resumable via public webhook endpoint
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
turso (51 failed):
  • addTenWorkflow
  • addTenWorkflow
  • wellKnownAgentWorkflow (.well-known/agent)
  • should work with react rendering in step
  • promiseAllWorkflow
  • promiseRaceWorkflow
  • promiseAnyWorkflow
  • importedStepOnlyWorkflow
  • hookWorkflow
  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • sleepingWorkflow
  • parallelSleepWorkflow
  • nullByteWorkflow
  • workflowAndStepMetadataWorkflow
  • fetchWorkflow
  • promiseRaceStressTestWorkflow
  • error handling error propagation workflow errors nested function calls preserve message and stack trace
  • error handling error propagation workflow errors cross-file imports preserve message and stack trace
  • error handling error propagation step errors basic step error preserves message and stack trace
  • error handling error propagation step errors cross-file step error preserves message and function names in stack
  • error handling retry behavior regular Error retries until success
  • error handling retry behavior FatalError fails immediately without retries
  • error handling retry behavior RetryableError respects custom retryAfter delay
  • error handling retry behavior maxRetries=0 disables retries
  • error handling catchability FatalError can be caught and detected with FatalError.is()
  • hookCleanupTestWorkflow - hook token reuse after workflow completion
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
  • hookDisposeTestWorkflow - hook token reuse after explicit disposal while workflow still running
  • stepFunctionPassingWorkflow - step function references can be passed as arguments (without closure vars)
  • stepFunctionWithClosureWorkflow - step function with closure variables passed as argument
  • closureVariableWorkflow - nested step functions with closure variables
  • spawnWorkflowFromStepWorkflow - spawning a child workflow using start() inside a step
  • health check (queue-based) - workflow and step endpoints respond to health check messages
  • pathsAliasWorkflow - TypeScript path aliases resolve correctly
  • Calculator.calculate - static workflow method using static step methods from another class
  • AllInOneService.processNumber - static workflow method using sibling static step methods
  • ChainableService.processWithThis - static step methods using this to reference the class
  • thisSerializationWorkflow - step function invoked with .call() and .apply()
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • stepFunctionAsStartArgWorkflow - step function reference passed as start() argument
  • cancelRun - cancelling a running workflow
  • cancelRun via CLI - cancelling a running workflow
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router
  • hookWithSleepWorkflow - hook payloads delivered correctly with concurrent sleep
  • sleepInLoopWorkflow - sleep inside loop with steps actually delays each iteration
  • sleepWithSequentialStepsWorkflow - sequential steps work with concurrent sleep (control)
Details by Category
✅ ▲ Vercel Production
AppPassedFailedSkipped
✅ astro6807
✅ example6807
✅ express6807
✅ fastify6807
✅ hono6807
✅ nextjs-turbopack7302
✅ nextjs-webpack7302
✅ nitro6807
✅ nuxt6807
✅ sveltekit6807
✅ vite6807
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack7203
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev302
❌ mongodb5233
✅ redis-dev302
❌ redis5323
✅ turso-dev302
❌ turso4513
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable6609
✅ e2e-local-postgres-nest-stable6609
✅ e2e-local-prod-nest-stable6609
📋 View full workflow run

This was referenced Jan 19, 2026
 Merged

 Merged

 Merged

@TooTallNateGraphite App
TooTallNate
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
This stack of pull requests is managed by Graphite. Learn more about stacking.

This was referenced Jan 19, 2026
 Merged

 Merged

@TooTallNate
TooTallNate
marked this pull request as ready for review
January 19, 2026 23:18
CopilotAI
review requested due to automatic review settings
January 19, 2026 23:18
@TooTallNate
TooTallNate
marked this pull request as draft
January 19, 2026 23:18
@vercel
vercelBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
example-nextjs-workflow-turbopackReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
example-nextjs-workflow-webpackReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
example-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-astro-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-express-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-fastify-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-hono-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-nitro-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-nuxt-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-sveltekit-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-vite-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-docsReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-nestReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-swc-playgroundReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
@TooTallNate
TooTallNateforce-pushed
the
01-19-add_documentation_for_custom_class_serialization
branch
from
cbe3550 to
9020264CompareJanuary 19, 2026 23:19
CopilotAI
reviewed
Jan 19, 2026
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
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 adds comprehensive documentation for the custom class serialization feature using the new @workflow/serde package. The documentation explains how developers can make their custom classes serializable in workflows by implementing WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols.
Changes:
  • Added a new "Custom Class Serialization" section to the serialization documentation with examples showing basic and complex usage patterns
  • Updated the docs-typecheck extractor to support MDX-style comments for @expect-error annotations in addition to HTML comments
  • Added the @workflow/serde package to the API reference navigation and index
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
FileDescription
packages/docs-typecheck/src/extractor.tsEnhanced regex to support both HTML and MDX comment formats for @expect-error annotations
docs/content/docs/foundations/serialization.mdxAdded comprehensive documentation section explaining custom class serialization with code examples
docs/content/docs/api-reference/meta.jsonAdded workflow-serde to the API reference pages list
docs/content/docs/api-reference/index.mdxAdded Card component linking to the @workflow/serde package documentation
.changeset/smooth-nails-do.mdEmpty changeset file (acceptable for documentation-only changes)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
@TooTallNate
TooTallNateforce-pushed
the
01-19-add_documentation_for_custom_class_serialization
branch
from
199d665 to
feb442fCompareMarch 10, 2026 21:27
@TooTallNate
Merge branch 'main' into 01-19-add_documentation_for_custom_class_ser…
a039439
…ialization
@TooTallNate
Merge branch 'main' of github.com:vercel/workflow into 01-19-add_docu…
1e6ec66
…mentation_for_custom_class_serialization
@TooTallNate
Enhance serialization docs: custom class examples with 'use step' ins…
7bf8785
…tance methods
- Add custom classes to Supported Serializable Types with anchor link
- Replace verbose parenthetical in Requirements with back-link
- Add [!code highlight] to Basic Example serde methods
- Simplify geometry.ts to import Point instead of redefining it
- Rewrite Complex Example to demonstrate 'use step' on instance methods
with realistic APIs (database, HTTP) and contrast with workflow-context methods
- Add pass-by-value note for 'this' context with return-and-reassign pattern
@TooTallNate
Fix docs typecheck: use correct @expect-error codes for Order examples
2946474
@TooTallNate
Fix pre-existing docs typecheck failures in workflow-serde API reference
81c671e
Add @skip-typecheck to bare static method signatures that aren't valid
standalone TypeScript.
VaguelySerious
VaguelySerious
approved these changes
Mar 17, 2026
View reviewed changes
Comment threadpackages/docs-typecheck/src/extractor.ts
const CODE_BLOCK_REGEX =
 /```(typescript|ts|javascript|js)(?:[^\S\n]+[^\n]*)?\n([\s\S]*?)```/g;
const EXPECT_ERROR_REGEX = /<!--\s*@expect-error:([0-9,\s]+)\s*-->/;
// Support both HTML comments (<!-- @expect-error:2351 -->) and MDX comments ({/* @expect-error:2351 */})
@VaguelySeriousVaguelySeriousMar 17, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

what is this change for?
@TooTallNateTooTallNateMar 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The @expect-error marker only supported HTML comment syntax (<!-- @expect-error:2351 -->), which was sufficient since the only prior usage was in a .md file (the docs-typecheck README). However, MDX files do not support HTML comments — the MDX parser rejects <!-- with "Unexpected character !". Since the serialization docs are .mdx files and need @expect-error markers, this adds support for the MDX comment syntax ({/* @expect-error:2351 */}) as an alternative. The @skip-typecheck marker already supported both formats.
@TooTallNate
Revert extractor changes, use HTML comments for @expect-error markers
330ebcf
The docs typecheck extractor only supports HTML comment syntax for
@expect-error on main. Use <!-- @expect-error:XXXX --> instead of
{/* @expect-error:XXXX */} to match the existing convention.
@TooTallNate
Use MDX comment syntax for @expect-error markers, add MDX support to …
9830710
…extractor
MDX files don't support HTML comments (<!-- -->). The extractor's
@expect-error regex only supported HTML syntax, but @skip-typecheck
already supported both. This aligns @expect-error to also support
the MDX comment syntax ({/* @expect-error:XXXX */}).
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

Copilot code reviewCopilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@VaguelySeriousVaguelySeriousVaguelySerious approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@TooTallNate@VaguelySerious

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add documentation for custom class serialization by TooTallNate · Pull Request #810 · vercel/workflow · GitHub
Skip to content
Add documentation for custom class serialization - #810
Merged
TooTallNate merged 8 commits into
mainfrom 
01-19-add_documentation_for_custom_class_serialization
Mar 18, 2026
Merged
Add documentation for custom class serialization#810
TooTallNate merged 8 commits into
mainfrom 
01-19-add_documentation_for_custom_class_serialization
Conversation
@TooTallNate
@TooTallNateTooTallNate
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Member
Added documentation for custom class serialization in workflows with new @workflow/serde package.
What changed?
  • Added documentation for the new @workflow/serde package that provides serialization symbols for custom class serialization
  • Added a new section to the serialization docs explaining how to make custom classes serializable
  • Added the @workflow/serde package to the API reference navigation
  • Updated the docs-typecheck extractor to support MDX comments for expect-error annotations
Why make this change?
Custom class serialization is an important feature for workflows that need to work with complex data structures. This documentation explains how developers can make their own classes serializable using the WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols from the new @workflow/serde package, enabling seamless passing of class instances between workflow and step functions.
@changeset-bot
changeset-botBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 9830710
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@github-actions
github-actionsBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
🧪 E2E Test Results
❌ Some tests failed
Summary
PassedFailedSkippedTotal
✅ ▲ Vercel Production758067825
✅ 💻 Local Development7820118900
✅ 📦 Local Production7820118900
✅ 🐘 Local Postgres7820118900
✅ 🪟 Windows720375
❌ 🌍 Community Worlds1185615189
✅ 📋 Other198027225
Total3492564664014
❌ Failed Tests
🌍 Community Worlds (56 failed)
mongodb (3 failed):
  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
redis (2 failed):
  • hookWorkflow is not resumable via public webhook endpoint
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
turso (51 failed):
  • addTenWorkflow
  • addTenWorkflow
  • wellKnownAgentWorkflow (.well-known/agent)
  • should work with react rendering in step
  • promiseAllWorkflow
  • promiseRaceWorkflow
  • promiseAnyWorkflow
  • importedStepOnlyWorkflow
  • hookWorkflow
  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • sleepingWorkflow
  • parallelSleepWorkflow
  • nullByteWorkflow
  • workflowAndStepMetadataWorkflow
  • fetchWorkflow
  • promiseRaceStressTestWorkflow
  • error handling error propagation workflow errors nested function calls preserve message and stack trace
  • error handling error propagation workflow errors cross-file imports preserve message and stack trace
  • error handling error propagation step errors basic step error preserves message and stack trace
  • error handling error propagation step errors cross-file step error preserves message and function names in stack
  • error handling retry behavior regular Error retries until success
  • error handling retry behavior FatalError fails immediately without retries
  • error handling retry behavior RetryableError respects custom retryAfter delay
  • error handling retry behavior maxRetries=0 disables retries
  • error handling catchability FatalError can be caught and detected with FatalError.is()
  • hookCleanupTestWorkflow - hook token reuse after workflow completion
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
  • hookDisposeTestWorkflow - hook token reuse after explicit disposal while workflow still running
  • stepFunctionPassingWorkflow - step function references can be passed as arguments (without closure vars)
  • stepFunctionWithClosureWorkflow - step function with closure variables passed as argument
  • closureVariableWorkflow - nested step functions with closure variables
  • spawnWorkflowFromStepWorkflow - spawning a child workflow using start() inside a step
  • health check (queue-based) - workflow and step endpoints respond to health check messages
  • pathsAliasWorkflow - TypeScript path aliases resolve correctly
  • Calculator.calculate - static workflow method using static step methods from another class
  • AllInOneService.processNumber - static workflow method using sibling static step methods
  • ChainableService.processWithThis - static step methods using this to reference the class
  • thisSerializationWorkflow - step function invoked with .call() and .apply()
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • stepFunctionAsStartArgWorkflow - step function reference passed as start() argument
  • cancelRun - cancelling a running workflow
  • cancelRun via CLI - cancelling a running workflow
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router
  • hookWithSleepWorkflow - hook payloads delivered correctly with concurrent sleep
  • sleepInLoopWorkflow - sleep inside loop with steps actually delays each iteration
  • sleepWithSequentialStepsWorkflow - sequential steps work with concurrent sleep (control)
Details by Category
✅ ▲ Vercel Production
AppPassedFailedSkipped
✅ astro6807
✅ example6807
✅ express6807
✅ fastify6807
✅ hono6807
✅ nextjs-turbopack7302
✅ nextjs-webpack7302
✅ nitro6807
✅ nuxt6807
✅ sveltekit6807
✅ vite6807
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack7203
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev302
❌ mongodb5233
✅ redis-dev302
❌ redis5323
✅ turso-dev302
❌ turso4513
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable6609
✅ e2e-local-postgres-nest-stable6609
✅ e2e-local-prod-nest-stable6609
📋 View full workflow run

This was referenced Jan 19, 2026
 Merged

 Merged

 Merged

@TooTallNateGraphite App
TooTallNate
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
This stack of pull requests is managed by Graphite. Learn more about stacking.

This was referenced Jan 19, 2026
 Merged

 Merged

@TooTallNate
TooTallNate
marked this pull request as ready for review
January 19, 2026 23:18
CopilotAI
review requested due to automatic review settings
January 19, 2026 23:18
@TooTallNate
TooTallNate
marked this pull request as draft
January 19, 2026 23:18
@vercel
vercelBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
example-nextjs-workflow-turbopackReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
example-nextjs-workflow-webpackReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
example-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-astro-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-express-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-fastify-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-hono-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-nitro-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-nuxt-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-sveltekit-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-vite-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-docsReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-nestReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-swc-playgroundReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
@TooTallNate
TooTallNateforce-pushed
the
01-19-add_documentation_for_custom_class_serialization
branch
from
cbe3550 to
9020264CompareJanuary 19, 2026 23:19
CopilotAI
reviewed
Jan 19, 2026
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
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 adds comprehensive documentation for the custom class serialization feature using the new @workflow/serde package. The documentation explains how developers can make their custom classes serializable in workflows by implementing WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols.
Changes:
  • Added a new "Custom Class Serialization" section to the serialization documentation with examples showing basic and complex usage patterns
  • Updated the docs-typecheck extractor to support MDX-style comments for @expect-error annotations in addition to HTML comments
  • Added the @workflow/serde package to the API reference navigation and index
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
FileDescription
packages/docs-typecheck/src/extractor.tsEnhanced regex to support both HTML and MDX comment formats for @expect-error annotations
docs/content/docs/foundations/serialization.mdxAdded comprehensive documentation section explaining custom class serialization with code examples
docs/content/docs/api-reference/meta.jsonAdded workflow-serde to the API reference pages list
docs/content/docs/api-reference/index.mdxAdded Card component linking to the @workflow/serde package documentation
.changeset/smooth-nails-do.mdEmpty changeset file (acceptable for documentation-only changes)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
@TooTallNate
TooTallNateforce-pushed
the
01-19-add_documentation_for_custom_class_serialization
branch
from
199d665 to
feb442fCompareMarch 10, 2026 21:27
@TooTallNate
Merge branch 'main' into 01-19-add_documentation_for_custom_class_ser…
a039439
…ialization
@TooTallNate
Merge branch 'main' of github.com:vercel/workflow into 01-19-add_docu…
1e6ec66
…mentation_for_custom_class_serialization
@TooTallNate
Enhance serialization docs: custom class examples with 'use step' ins…
7bf8785
…tance methods
- Add custom classes to Supported Serializable Types with anchor link
- Replace verbose parenthetical in Requirements with back-link
- Add [!code highlight] to Basic Example serde methods
- Simplify geometry.ts to import Point instead of redefining it
- Rewrite Complex Example to demonstrate 'use step' on instance methods
with realistic APIs (database, HTTP) and contrast with workflow-context methods
- Add pass-by-value note for 'this' context with return-and-reassign pattern
@TooTallNate
Fix docs typecheck: use correct @expect-error codes for Order examples
2946474
@TooTallNate
Fix pre-existing docs typecheck failures in workflow-serde API reference
81c671e
Add @skip-typecheck to bare static method signatures that aren't valid
standalone TypeScript.
VaguelySerious
VaguelySerious
approved these changes
Mar 17, 2026
View reviewed changes
Comment threadpackages/docs-typecheck/src/extractor.ts
const CODE_BLOCK_REGEX =
 /```(typescript|ts|javascript|js)(?:[^\S\n]+[^\n]*)?\n([\s\S]*?)```/g;
const EXPECT_ERROR_REGEX = /<!--\s*@expect-error:([0-9,\s]+)\s*-->/;
// Support both HTML comments (<!-- @expect-error:2351 -->) and MDX comments ({/* @expect-error:2351 */})
@VaguelySeriousVaguelySeriousMar 17, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

what is this change for?
@TooTallNateTooTallNateMar 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The @expect-error marker only supported HTML comment syntax (<!-- @expect-error:2351 -->), which was sufficient since the only prior usage was in a .md file (the docs-typecheck README). However, MDX files do not support HTML comments — the MDX parser rejects <!-- with "Unexpected character !". Since the serialization docs are .mdx files and need @expect-error markers, this adds support for the MDX comment syntax ({/* @expect-error:2351 */}) as an alternative. The @skip-typecheck marker already supported both formats.
@TooTallNate
Revert extractor changes, use HTML comments for @expect-error markers
330ebcf
The docs typecheck extractor only supports HTML comment syntax for
@expect-error on main. Use <!-- @expect-error:XXXX --> instead of
{/* @expect-error:XXXX */} to match the existing convention.
@TooTallNate
Use MDX comment syntax for @expect-error markers, add MDX support to …
9830710
…extractor
MDX files don't support HTML comments (<!-- -->). The extractor's
@expect-error regex only supported HTML syntax, but @skip-typecheck
already supported both. This aligns @expect-error to also support
the MDX comment syntax ({/* @expect-error:XXXX */}).
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

Copilot code reviewCopilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@VaguelySeriousVaguelySeriousVaguelySerious approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@TooTallNate@VaguelySerious

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add documentation for custom class serialization by TooTallNate · Pull Request #810 · vercel/workflow · GitHub
Skip to content
Add documentation for custom class serialization - #810
Merged
TooTallNate merged 8 commits into
mainfrom 
01-19-add_documentation_for_custom_class_serialization
Mar 18, 2026
Merged
Add documentation for custom class serialization#810
TooTallNate merged 8 commits into
mainfrom 
01-19-add_documentation_for_custom_class_serialization
Conversation
@TooTallNate
@TooTallNateTooTallNate
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Member
Added documentation for custom class serialization in workflows with new @workflow/serde package.
What changed?
  • Added documentation for the new @workflow/serde package that provides serialization symbols for custom class serialization
  • Added a new section to the serialization docs explaining how to make custom classes serializable
  • Added the @workflow/serde package to the API reference navigation
  • Updated the docs-typecheck extractor to support MDX comments for expect-error annotations
Why make this change?
Custom class serialization is an important feature for workflows that need to work with complex data structures. This documentation explains how developers can make their own classes serializable using the WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols from the new @workflow/serde package, enabling seamless passing of class instances between workflow and step functions.
@changeset-bot
changeset-botBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 9830710
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@github-actions
github-actionsBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
🧪 E2E Test Results
❌ Some tests failed
Summary
PassedFailedSkippedTotal
✅ ▲ Vercel Production758067825
✅ 💻 Local Development7820118900
✅ 📦 Local Production7820118900
✅ 🐘 Local Postgres7820118900
✅ 🪟 Windows720375
❌ 🌍 Community Worlds1185615189
✅ 📋 Other198027225
Total3492564664014
❌ Failed Tests
🌍 Community Worlds (56 failed)
mongodb (3 failed):
  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
redis (2 failed):
  • hookWorkflow is not resumable via public webhook endpoint
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
turso (51 failed):
  • addTenWorkflow
  • addTenWorkflow
  • wellKnownAgentWorkflow (.well-known/agent)
  • should work with react rendering in step
  • promiseAllWorkflow
  • promiseRaceWorkflow
  • promiseAnyWorkflow
  • importedStepOnlyWorkflow
  • hookWorkflow
  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • sleepingWorkflow
  • parallelSleepWorkflow
  • nullByteWorkflow
  • workflowAndStepMetadataWorkflow
  • fetchWorkflow
  • promiseRaceStressTestWorkflow
  • error handling error propagation workflow errors nested function calls preserve message and stack trace
  • error handling error propagation workflow errors cross-file imports preserve message and stack trace
  • error handling error propagation step errors basic step error preserves message and stack trace
  • error handling error propagation step errors cross-file step error preserves message and function names in stack
  • error handling retry behavior regular Error retries until success
  • error handling retry behavior FatalError fails immediately without retries
  • error handling retry behavior RetryableError respects custom retryAfter delay
  • error handling retry behavior maxRetries=0 disables retries
  • error handling catchability FatalError can be caught and detected with FatalError.is()
  • hookCleanupTestWorkflow - hook token reuse after workflow completion
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
  • hookDisposeTestWorkflow - hook token reuse after explicit disposal while workflow still running
  • stepFunctionPassingWorkflow - step function references can be passed as arguments (without closure vars)
  • stepFunctionWithClosureWorkflow - step function with closure variables passed as argument
  • closureVariableWorkflow - nested step functions with closure variables
  • spawnWorkflowFromStepWorkflow - spawning a child workflow using start() inside a step
  • health check (queue-based) - workflow and step endpoints respond to health check messages
  • pathsAliasWorkflow - TypeScript path aliases resolve correctly
  • Calculator.calculate - static workflow method using static step methods from another class
  • AllInOneService.processNumber - static workflow method using sibling static step methods
  • ChainableService.processWithThis - static step methods using this to reference the class
  • thisSerializationWorkflow - step function invoked with .call() and .apply()
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • stepFunctionAsStartArgWorkflow - step function reference passed as start() argument
  • cancelRun - cancelling a running workflow
  • cancelRun via CLI - cancelling a running workflow
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router
  • hookWithSleepWorkflow - hook payloads delivered correctly with concurrent sleep
  • sleepInLoopWorkflow - sleep inside loop with steps actually delays each iteration
  • sleepWithSequentialStepsWorkflow - sequential steps work with concurrent sleep (control)
Details by Category
✅ ▲ Vercel Production
AppPassedFailedSkipped
✅ astro6807
✅ example6807
✅ express6807
✅ fastify6807
✅ hono6807
✅ nextjs-turbopack7302
✅ nextjs-webpack7302
✅ nitro6807
✅ nuxt6807
✅ sveltekit6807
✅ vite6807
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack7203
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev302
❌ mongodb5233
✅ redis-dev302
❌ redis5323
✅ turso-dev302
❌ turso4513
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable6609
✅ e2e-local-postgres-nest-stable6609
✅ e2e-local-prod-nest-stable6609
📋 View full workflow run

This was referenced Jan 19, 2026
 Merged

 Merged

 Merged

@TooTallNateGraphite App
TooTallNate
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
This stack of pull requests is managed by Graphite. Learn more about stacking.

This was referenced Jan 19, 2026
 Merged

 Merged

@TooTallNate
TooTallNate
marked this pull request as ready for review
January 19, 2026 23:18
CopilotAI
review requested due to automatic review settings
January 19, 2026 23:18
@TooTallNate
TooTallNate
marked this pull request as draft
January 19, 2026 23:18
@vercel
vercelBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
example-nextjs-workflow-turbopackReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
example-nextjs-workflow-webpackReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
example-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-astro-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-express-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-fastify-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-hono-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-nitro-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-nuxt-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-sveltekit-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-vite-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-docsReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-nestReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-swc-playgroundReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
@TooTallNate
TooTallNateforce-pushed
the
01-19-add_documentation_for_custom_class_serialization
branch
from
cbe3550 to
9020264CompareJanuary 19, 2026 23:19
CopilotAI
reviewed
Jan 19, 2026
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
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 adds comprehensive documentation for the custom class serialization feature using the new @workflow/serde package. The documentation explains how developers can make their custom classes serializable in workflows by implementing WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols.
Changes:
  • Added a new "Custom Class Serialization" section to the serialization documentation with examples showing basic and complex usage patterns
  • Updated the docs-typecheck extractor to support MDX-style comments for @expect-error annotations in addition to HTML comments
  • Added the @workflow/serde package to the API reference navigation and index
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
FileDescription
packages/docs-typecheck/src/extractor.tsEnhanced regex to support both HTML and MDX comment formats for @expect-error annotations
docs/content/docs/foundations/serialization.mdxAdded comprehensive documentation section explaining custom class serialization with code examples
docs/content/docs/api-reference/meta.jsonAdded workflow-serde to the API reference pages list
docs/content/docs/api-reference/index.mdxAdded Card component linking to the @workflow/serde package documentation
.changeset/smooth-nails-do.mdEmpty changeset file (acceptable for documentation-only changes)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
@TooTallNate
TooTallNateforce-pushed
the
01-19-add_documentation_for_custom_class_serialization
branch
from
199d665 to
feb442fCompareMarch 10, 2026 21:27
@TooTallNate
Merge branch 'main' into 01-19-add_documentation_for_custom_class_ser…
a039439
…ialization
@TooTallNate
Merge branch 'main' of github.com:vercel/workflow into 01-19-add_docu…
1e6ec66
…mentation_for_custom_class_serialization
@TooTallNate
Enhance serialization docs: custom class examples with 'use step' ins…
7bf8785
…tance methods
- Add custom classes to Supported Serializable Types with anchor link
- Replace verbose parenthetical in Requirements with back-link
- Add [!code highlight] to Basic Example serde methods
- Simplify geometry.ts to import Point instead of redefining it
- Rewrite Complex Example to demonstrate 'use step' on instance methods
with realistic APIs (database, HTTP) and contrast with workflow-context methods
- Add pass-by-value note for 'this' context with return-and-reassign pattern
@TooTallNate
Fix docs typecheck: use correct @expect-error codes for Order examples
2946474
@TooTallNate
Fix pre-existing docs typecheck failures in workflow-serde API reference
81c671e
Add @skip-typecheck to bare static method signatures that aren't valid
standalone TypeScript.
VaguelySerious
VaguelySerious
approved these changes
Mar 17, 2026
View reviewed changes
Comment threadpackages/docs-typecheck/src/extractor.ts
const CODE_BLOCK_REGEX =
 /```(typescript|ts|javascript|js)(?:[^\S\n]+[^\n]*)?\n([\s\S]*?)```/g;
const EXPECT_ERROR_REGEX = /<!--\s*@expect-error:([0-9,\s]+)\s*-->/;
// Support both HTML comments (<!-- @expect-error:2351 -->) and MDX comments ({/* @expect-error:2351 */})
@VaguelySeriousVaguelySeriousMar 17, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

what is this change for?
@TooTallNateTooTallNateMar 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The @expect-error marker only supported HTML comment syntax (<!-- @expect-error:2351 -->), which was sufficient since the only prior usage was in a .md file (the docs-typecheck README). However, MDX files do not support HTML comments — the MDX parser rejects <!-- with "Unexpected character !". Since the serialization docs are .mdx files and need @expect-error markers, this adds support for the MDX comment syntax ({/* @expect-error:2351 */}) as an alternative. The @skip-typecheck marker already supported both formats.
@TooTallNate
Revert extractor changes, use HTML comments for @expect-error markers
330ebcf
The docs typecheck extractor only supports HTML comment syntax for
@expect-error on main. Use <!-- @expect-error:XXXX --> instead of
{/* @expect-error:XXXX */} to match the existing convention.
@TooTallNate
Use MDX comment syntax for @expect-error markers, add MDX support to …
9830710
…extractor
MDX files don't support HTML comments (<!-- -->). The extractor's
@expect-error regex only supported HTML syntax, but @skip-typecheck
already supported both. This aligns @expect-error to also support
the MDX comment syntax ({/* @expect-error:XXXX */}).
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

Copilot code reviewCopilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@VaguelySeriousVaguelySeriousVaguelySerious approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@TooTallNate@VaguelySerious

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Add documentation for custom class serialization by TooTallNate · Pull Request #810 · vercel/workflow · GitHub
Skip to content
Add documentation for custom class serialization - #810
Merged
TooTallNate merged 8 commits into
mainfrom 
01-19-add_documentation_for_custom_class_serialization
Mar 18, 2026
Merged
Add documentation for custom class serialization#810
TooTallNate merged 8 commits into
mainfrom 
01-19-add_documentation_for_custom_class_serialization
Conversation
@TooTallNate
@TooTallNateTooTallNate
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Member
Added documentation for custom class serialization in workflows with new @workflow/serde package.
What changed?
  • Added documentation for the new @workflow/serde package that provides serialization symbols for custom class serialization
  • Added a new section to the serialization docs explaining how to make custom classes serializable
  • Added the @workflow/serde package to the API reference navigation
  • Updated the docs-typecheck extractor to support MDX comments for expect-error annotations
Why make this change?
Custom class serialization is an important feature for workflows that need to work with complex data structures. This documentation explains how developers can make their own classes serializable using the WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols from the new @workflow/serde package, enabling seamless passing of class instances between workflow and step functions.
@changeset-bot
changeset-botBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 9830710
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@github-actions
github-actionsBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
🧪 E2E Test Results
❌ Some tests failed
Summary
PassedFailedSkippedTotal
✅ ▲ Vercel Production758067825
✅ 💻 Local Development7820118900
✅ 📦 Local Production7820118900
✅ 🐘 Local Postgres7820118900
✅ 🪟 Windows720375
❌ 🌍 Community Worlds1185615189
✅ 📋 Other198027225
Total3492564664014
❌ Failed Tests
🌍 Community Worlds (56 failed)
mongodb (3 failed):
  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
redis (2 failed):
  • hookWorkflow is not resumable via public webhook endpoint
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
turso (51 failed):
  • addTenWorkflow
  • addTenWorkflow
  • wellKnownAgentWorkflow (.well-known/agent)
  • should work with react rendering in step
  • promiseAllWorkflow
  • promiseRaceWorkflow
  • promiseAnyWorkflow
  • importedStepOnlyWorkflow
  • hookWorkflow
  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • sleepingWorkflow
  • parallelSleepWorkflow
  • nullByteWorkflow
  • workflowAndStepMetadataWorkflow
  • fetchWorkflow
  • promiseRaceStressTestWorkflow
  • error handling error propagation workflow errors nested function calls preserve message and stack trace
  • error handling error propagation workflow errors cross-file imports preserve message and stack trace
  • error handling error propagation step errors basic step error preserves message and stack trace
  • error handling error propagation step errors cross-file step error preserves message and function names in stack
  • error handling retry behavior regular Error retries until success
  • error handling retry behavior FatalError fails immediately without retries
  • error handling retry behavior RetryableError respects custom retryAfter delay
  • error handling retry behavior maxRetries=0 disables retries
  • error handling catchability FatalError can be caught and detected with FatalError.is()
  • hookCleanupTestWorkflow - hook token reuse after workflow completion
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
  • hookDisposeTestWorkflow - hook token reuse after explicit disposal while workflow still running
  • stepFunctionPassingWorkflow - step function references can be passed as arguments (without closure vars)
  • stepFunctionWithClosureWorkflow - step function with closure variables passed as argument
  • closureVariableWorkflow - nested step functions with closure variables
  • spawnWorkflowFromStepWorkflow - spawning a child workflow using start() inside a step
  • health check (queue-based) - workflow and step endpoints respond to health check messages
  • pathsAliasWorkflow - TypeScript path aliases resolve correctly
  • Calculator.calculate - static workflow method using static step methods from another class
  • AllInOneService.processNumber - static workflow method using sibling static step methods
  • ChainableService.processWithThis - static step methods using this to reference the class
  • thisSerializationWorkflow - step function invoked with .call() and .apply()
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • stepFunctionAsStartArgWorkflow - step function reference passed as start() argument
  • cancelRun - cancelling a running workflow
  • cancelRun via CLI - cancelling a running workflow
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router
  • hookWithSleepWorkflow - hook payloads delivered correctly with concurrent sleep
  • sleepInLoopWorkflow - sleep inside loop with steps actually delays each iteration
  • sleepWithSequentialStepsWorkflow - sequential steps work with concurrent sleep (control)
Details by Category
✅ ▲ Vercel Production
AppPassedFailedSkipped
✅ astro6807
✅ example6807
✅ express6807
✅ fastify6807
✅ hono6807
✅ nextjs-turbopack7302
✅ nextjs-webpack7302
✅ nitro6807
✅ nuxt6807
✅ sveltekit6807
✅ vite6807
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack7203
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev302
❌ mongodb5233
✅ redis-dev302
❌ redis5323
✅ turso-dev302
❌ turso4513
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable6609
✅ e2e-local-postgres-nest-stable6609
✅ e2e-local-prod-nest-stable6609
📋 View full workflow run

This was referenced Jan 19, 2026
 Merged

 Merged

 Merged

@TooTallNateGraphite App
TooTallNate
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
This stack of pull requests is managed by Graphite. Learn more about stacking.

This was referenced Jan 19, 2026
 Merged

 Merged

@TooTallNate
TooTallNate
marked this pull request as ready for review
January 19, 2026 23:18
CopilotAI
review requested due to automatic review settings
January 19, 2026 23:18
@TooTallNate
TooTallNate
marked this pull request as draft
January 19, 2026 23:18
@vercel
vercelBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
example-nextjs-workflow-turbopackReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
example-nextjs-workflow-webpackReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
example-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-astro-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-express-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-fastify-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-hono-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-nitro-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-nuxt-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-sveltekit-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-vite-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-docsReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-nestReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-swc-playgroundReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
@TooTallNate
TooTallNateforce-pushed
the
01-19-add_documentation_for_custom_class_serialization
branch
from
cbe3550 to
9020264CompareJanuary 19, 2026 23:19
CopilotAI
reviewed
Jan 19, 2026
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
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 adds comprehensive documentation for the custom class serialization feature using the new @workflow/serde package. The documentation explains how developers can make their custom classes serializable in workflows by implementing WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols.
Changes:
  • Added a new "Custom Class Serialization" section to the serialization documentation with examples showing basic and complex usage patterns
  • Updated the docs-typecheck extractor to support MDX-style comments for @expect-error annotations in addition to HTML comments
  • Added the @workflow/serde package to the API reference navigation and index
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
FileDescription
packages/docs-typecheck/src/extractor.tsEnhanced regex to support both HTML and MDX comment formats for @expect-error annotations
docs/content/docs/foundations/serialization.mdxAdded comprehensive documentation section explaining custom class serialization with code examples
docs/content/docs/api-reference/meta.jsonAdded workflow-serde to the API reference pages list
docs/content/docs/api-reference/index.mdxAdded Card component linking to the @workflow/serde package documentation
.changeset/smooth-nails-do.mdEmpty changeset file (acceptable for documentation-only changes)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
@TooTallNate
TooTallNateforce-pushed
the
01-19-add_documentation_for_custom_class_serialization
branch
from
199d665 to
feb442fCompareMarch 10, 2026 21:27
@TooTallNate
Merge branch 'main' into 01-19-add_documentation_for_custom_class_ser…
a039439
…ialization
@TooTallNate
Merge branch 'main' of github.com:vercel/workflow into 01-19-add_docu…
1e6ec66
…mentation_for_custom_class_serialization
@TooTallNate
Enhance serialization docs: custom class examples with 'use step' ins…
7bf8785
…tance methods
- Add custom classes to Supported Serializable Types with anchor link
- Replace verbose parenthetical in Requirements with back-link
- Add [!code highlight] to Basic Example serde methods
- Simplify geometry.ts to import Point instead of redefining it
- Rewrite Complex Example to demonstrate 'use step' on instance methods
with realistic APIs (database, HTTP) and contrast with workflow-context methods
- Add pass-by-value note for 'this' context with return-and-reassign pattern
@TooTallNate
Fix docs typecheck: use correct @expect-error codes for Order examples
2946474
@TooTallNate
Fix pre-existing docs typecheck failures in workflow-serde API reference
81c671e
Add @skip-typecheck to bare static method signatures that aren't valid
standalone TypeScript.
VaguelySerious
VaguelySerious
approved these changes
Mar 17, 2026
View reviewed changes
Comment threadpackages/docs-typecheck/src/extractor.ts
const CODE_BLOCK_REGEX =
 /```(typescript|ts|javascript|js)(?:[^\S\n]+[^\n]*)?\n([\s\S]*?)```/g;
const EXPECT_ERROR_REGEX = /<!--\s*@expect-error:([0-9,\s]+)\s*-->/;
// Support both HTML comments (<!-- @expect-error:2351 -->) and MDX comments ({/* @expect-error:2351 */})
@VaguelySeriousVaguelySeriousMar 17, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

what is this change for?
@TooTallNateTooTallNateMar 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The @expect-error marker only supported HTML comment syntax (<!-- @expect-error:2351 -->), which was sufficient since the only prior usage was in a .md file (the docs-typecheck README). However, MDX files do not support HTML comments — the MDX parser rejects <!-- with "Unexpected character !". Since the serialization docs are .mdx files and need @expect-error markers, this adds support for the MDX comment syntax ({/* @expect-error:2351 */}) as an alternative. The @skip-typecheck marker already supported both formats.
@TooTallNate
Revert extractor changes, use HTML comments for @expect-error markers
330ebcf
The docs typecheck extractor only supports HTML comment syntax for
@expect-error on main. Use <!-- @expect-error:XXXX --> instead of
{/* @expect-error:XXXX */} to match the existing convention.
@TooTallNate
Use MDX comment syntax for @expect-error markers, add MDX support to …
9830710
…extractor
MDX files don't support HTML comments (<!-- -->). The extractor's
@expect-error regex only supported HTML syntax, but @skip-typecheck
already supported both. This aligns @expect-error to also support
the MDX comment syntax ({/* @expect-error:XXXX */}).
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

Copilot code reviewCopilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@VaguelySeriousVaguelySeriousVaguelySerious approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@TooTallNate@VaguelySerious

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add documentation for custom class serialization by TooTallNate · Pull Request #810 · vercel/workflow · GitHub
Skip to content
Add documentation for custom class serialization - #810
Merged
TooTallNate merged 8 commits into
mainfrom 
01-19-add_documentation_for_custom_class_serialization
Mar 18, 2026
Merged
Add documentation for custom class serialization#810
TooTallNate merged 8 commits into
mainfrom 
01-19-add_documentation_for_custom_class_serialization
Conversation
@TooTallNate
@TooTallNateTooTallNate
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Member
Added documentation for custom class serialization in workflows with new @workflow/serde package.
What changed?
  • Added documentation for the new @workflow/serde package that provides serialization symbols for custom class serialization
  • Added a new section to the serialization docs explaining how to make custom classes serializable
  • Added the @workflow/serde package to the API reference navigation
  • Updated the docs-typecheck extractor to support MDX comments for expect-error annotations
Why make this change?
Custom class serialization is an important feature for workflows that need to work with complex data structures. This documentation explains how developers can make their own classes serializable using the WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols from the new @workflow/serde package, enabling seamless passing of class instances between workflow and step functions.
@changeset-bot
changeset-botBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 9830710
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@github-actions
github-actionsBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
🧪 E2E Test Results
❌ Some tests failed
Summary
PassedFailedSkippedTotal
✅ ▲ Vercel Production758067825
✅ 💻 Local Development7820118900
✅ 📦 Local Production7820118900
✅ 🐘 Local Postgres7820118900
✅ 🪟 Windows720375
❌ 🌍 Community Worlds1185615189
✅ 📋 Other198027225
Total3492564664014
❌ Failed Tests
🌍 Community Worlds (56 failed)
mongodb (3 failed):
  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
redis (2 failed):
  • hookWorkflow is not resumable via public webhook endpoint
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
turso (51 failed):
  • addTenWorkflow
  • addTenWorkflow
  • wellKnownAgentWorkflow (.well-known/agent)
  • should work with react rendering in step
  • promiseAllWorkflow
  • promiseRaceWorkflow
  • promiseAnyWorkflow
  • importedStepOnlyWorkflow
  • hookWorkflow
  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • sleepingWorkflow
  • parallelSleepWorkflow
  • nullByteWorkflow
  • workflowAndStepMetadataWorkflow
  • fetchWorkflow
  • promiseRaceStressTestWorkflow
  • error handling error propagation workflow errors nested function calls preserve message and stack trace
  • error handling error propagation workflow errors cross-file imports preserve message and stack trace
  • error handling error propagation step errors basic step error preserves message and stack trace
  • error handling error propagation step errors cross-file step error preserves message and function names in stack
  • error handling retry behavior regular Error retries until success
  • error handling retry behavior FatalError fails immediately without retries
  • error handling retry behavior RetryableError respects custom retryAfter delay
  • error handling retry behavior maxRetries=0 disables retries
  • error handling catchability FatalError can be caught and detected with FatalError.is()
  • hookCleanupTestWorkflow - hook token reuse after workflow completion
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
  • hookDisposeTestWorkflow - hook token reuse after explicit disposal while workflow still running
  • stepFunctionPassingWorkflow - step function references can be passed as arguments (without closure vars)
  • stepFunctionWithClosureWorkflow - step function with closure variables passed as argument
  • closureVariableWorkflow - nested step functions with closure variables
  • spawnWorkflowFromStepWorkflow - spawning a child workflow using start() inside a step
  • health check (queue-based) - workflow and step endpoints respond to health check messages
  • pathsAliasWorkflow - TypeScript path aliases resolve correctly
  • Calculator.calculate - static workflow method using static step methods from another class
  • AllInOneService.processNumber - static workflow method using sibling static step methods
  • ChainableService.processWithThis - static step methods using this to reference the class
  • thisSerializationWorkflow - step function invoked with .call() and .apply()
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • stepFunctionAsStartArgWorkflow - step function reference passed as start() argument
  • cancelRun - cancelling a running workflow
  • cancelRun via CLI - cancelling a running workflow
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router
  • hookWithSleepWorkflow - hook payloads delivered correctly with concurrent sleep
  • sleepInLoopWorkflow - sleep inside loop with steps actually delays each iteration
  • sleepWithSequentialStepsWorkflow - sequential steps work with concurrent sleep (control)
Details by Category
✅ ▲ Vercel Production
AppPassedFailedSkipped
✅ astro6807
✅ example6807
✅ express6807
✅ fastify6807
✅ hono6807
✅ nextjs-turbopack7302
✅ nextjs-webpack7302
✅ nitro6807
✅ nuxt6807
✅ sveltekit6807
✅ vite6807
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack7203
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev302
❌ mongodb5233
✅ redis-dev302
❌ redis5323
✅ turso-dev302
❌ turso4513
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable6609
✅ e2e-local-postgres-nest-stable6609
✅ e2e-local-prod-nest-stable6609
📋 View full workflow run

This was referenced Jan 19, 2026
 Merged

 Merged

 Merged

@TooTallNateGraphite App
TooTallNate
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
This stack of pull requests is managed by Graphite. Learn more about stacking.

This was referenced Jan 19, 2026
 Merged

 Merged

@TooTallNate
TooTallNate
marked this pull request as ready for review
January 19, 2026 23:18
CopilotAI
review requested due to automatic review settings
January 19, 2026 23:18
@TooTallNate
TooTallNate
marked this pull request as draft
January 19, 2026 23:18
@vercel
vercelBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
example-nextjs-workflow-turbopackReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
example-nextjs-workflow-webpackReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
example-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-astro-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-express-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-fastify-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-hono-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-nitro-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-nuxt-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-sveltekit-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-vite-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-docsReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-nestReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-swc-playgroundReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
@TooTallNate
TooTallNateforce-pushed
the
01-19-add_documentation_for_custom_class_serialization
branch
from
cbe3550 to
9020264CompareJanuary 19, 2026 23:19
CopilotAI
reviewed
Jan 19, 2026
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
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 adds comprehensive documentation for the custom class serialization feature using the new @workflow/serde package. The documentation explains how developers can make their custom classes serializable in workflows by implementing WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols.
Changes:
  • Added a new "Custom Class Serialization" section to the serialization documentation with examples showing basic and complex usage patterns
  • Updated the docs-typecheck extractor to support MDX-style comments for @expect-error annotations in addition to HTML comments
  • Added the @workflow/serde package to the API reference navigation and index
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
FileDescription
packages/docs-typecheck/src/extractor.tsEnhanced regex to support both HTML and MDX comment formats for @expect-error annotations
docs/content/docs/foundations/serialization.mdxAdded comprehensive documentation section explaining custom class serialization with code examples
docs/content/docs/api-reference/meta.jsonAdded workflow-serde to the API reference pages list
docs/content/docs/api-reference/index.mdxAdded Card component linking to the @workflow/serde package documentation
.changeset/smooth-nails-do.mdEmpty changeset file (acceptable for documentation-only changes)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
@TooTallNate
TooTallNateforce-pushed
the
01-19-add_documentation_for_custom_class_serialization
branch
from
199d665 to
feb442fCompareMarch 10, 2026 21:27
@TooTallNate
Merge branch 'main' into 01-19-add_documentation_for_custom_class_ser…
a039439
…ialization
@TooTallNate
Merge branch 'main' of github.com:vercel/workflow into 01-19-add_docu…
1e6ec66
…mentation_for_custom_class_serialization
@TooTallNate
Enhance serialization docs: custom class examples with 'use step' ins…
7bf8785
…tance methods
- Add custom classes to Supported Serializable Types with anchor link
- Replace verbose parenthetical in Requirements with back-link
- Add [!code highlight] to Basic Example serde methods
- Simplify geometry.ts to import Point instead of redefining it
- Rewrite Complex Example to demonstrate 'use step' on instance methods
with realistic APIs (database, HTTP) and contrast with workflow-context methods
- Add pass-by-value note for 'this' context with return-and-reassign pattern
@TooTallNate
Fix docs typecheck: use correct @expect-error codes for Order examples
2946474
@TooTallNate
Fix pre-existing docs typecheck failures in workflow-serde API reference
81c671e
Add @skip-typecheck to bare static method signatures that aren't valid
standalone TypeScript.
VaguelySerious
VaguelySerious
approved these changes
Mar 17, 2026
View reviewed changes
Comment threadpackages/docs-typecheck/src/extractor.ts
const CODE_BLOCK_REGEX =
 /```(typescript|ts|javascript|js)(?:[^\S\n]+[^\n]*)?\n([\s\S]*?)```/g;
const EXPECT_ERROR_REGEX = /<!--\s*@expect-error:([0-9,\s]+)\s*-->/;
// Support both HTML comments (<!-- @expect-error:2351 -->) and MDX comments ({/* @expect-error:2351 */})
@VaguelySeriousVaguelySeriousMar 17, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

what is this change for?
@TooTallNateTooTallNateMar 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The @expect-error marker only supported HTML comment syntax (<!-- @expect-error:2351 -->), which was sufficient since the only prior usage was in a .md file (the docs-typecheck README). However, MDX files do not support HTML comments — the MDX parser rejects <!-- with "Unexpected character !". Since the serialization docs are .mdx files and need @expect-error markers, this adds support for the MDX comment syntax ({/* @expect-error:2351 */}) as an alternative. The @skip-typecheck marker already supported both formats.
@TooTallNate
Revert extractor changes, use HTML comments for @expect-error markers
330ebcf
The docs typecheck extractor only supports HTML comment syntax for
@expect-error on main. Use <!-- @expect-error:XXXX --> instead of
{/* @expect-error:XXXX */} to match the existing convention.
@TooTallNate
Use MDX comment syntax for @expect-error markers, add MDX support to …
9830710
…extractor
MDX files don't support HTML comments (<!-- -->). The extractor's
@expect-error regex only supported HTML syntax, but @skip-typecheck
already supported both. This aligns @expect-error to also support
the MDX comment syntax ({/* @expect-error:XXXX */}).
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

Copilot code reviewCopilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@VaguelySeriousVaguelySeriousVaguelySerious approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@TooTallNate@VaguelySerious

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add documentation for custom class serialization by TooTallNate · Pull Request #810 · vercel/workflow · GitHub
Skip to content
Add documentation for custom class serialization - #810
Merged
TooTallNate merged 8 commits into
mainfrom 
01-19-add_documentation_for_custom_class_serialization
Mar 18, 2026
Merged
Add documentation for custom class serialization#810
TooTallNate merged 8 commits into
mainfrom 
01-19-add_documentation_for_custom_class_serialization
Conversation
@TooTallNate
@TooTallNateTooTallNate
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Member
Added documentation for custom class serialization in workflows with new @workflow/serde package.
What changed?
  • Added documentation for the new @workflow/serde package that provides serialization symbols for custom class serialization
  • Added a new section to the serialization docs explaining how to make custom classes serializable
  • Added the @workflow/serde package to the API reference navigation
  • Updated the docs-typecheck extractor to support MDX comments for expect-error annotations
Why make this change?
Custom class serialization is an important feature for workflows that need to work with complex data structures. This documentation explains how developers can make their own classes serializable using the WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols from the new @workflow/serde package, enabling seamless passing of class instances between workflow and step functions.
@changeset-bot
changeset-botBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 9830710
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@github-actions
github-actionsBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
🧪 E2E Test Results
❌ Some tests failed
Summary
PassedFailedSkippedTotal
✅ ▲ Vercel Production758067825
✅ 💻 Local Development7820118900
✅ 📦 Local Production7820118900
✅ 🐘 Local Postgres7820118900
✅ 🪟 Windows720375
❌ 🌍 Community Worlds1185615189
✅ 📋 Other198027225
Total3492564664014
❌ Failed Tests
🌍 Community Worlds (56 failed)
mongodb (3 failed):
  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
redis (2 failed):
  • hookWorkflow is not resumable via public webhook endpoint
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
turso (51 failed):
  • addTenWorkflow
  • addTenWorkflow
  • wellKnownAgentWorkflow (.well-known/agent)
  • should work with react rendering in step
  • promiseAllWorkflow
  • promiseRaceWorkflow
  • promiseAnyWorkflow
  • importedStepOnlyWorkflow
  • hookWorkflow
  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • sleepingWorkflow
  • parallelSleepWorkflow
  • nullByteWorkflow
  • workflowAndStepMetadataWorkflow
  • fetchWorkflow
  • promiseRaceStressTestWorkflow
  • error handling error propagation workflow errors nested function calls preserve message and stack trace
  • error handling error propagation workflow errors cross-file imports preserve message and stack trace
  • error handling error propagation step errors basic step error preserves message and stack trace
  • error handling error propagation step errors cross-file step error preserves message and function names in stack
  • error handling retry behavior regular Error retries until success
  • error handling retry behavior FatalError fails immediately without retries
  • error handling retry behavior RetryableError respects custom retryAfter delay
  • error handling retry behavior maxRetries=0 disables retries
  • error handling catchability FatalError can be caught and detected with FatalError.is()
  • hookCleanupTestWorkflow - hook token reuse after workflow completion
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
  • hookDisposeTestWorkflow - hook token reuse after explicit disposal while workflow still running
  • stepFunctionPassingWorkflow - step function references can be passed as arguments (without closure vars)
  • stepFunctionWithClosureWorkflow - step function with closure variables passed as argument
  • closureVariableWorkflow - nested step functions with closure variables
  • spawnWorkflowFromStepWorkflow - spawning a child workflow using start() inside a step
  • health check (queue-based) - workflow and step endpoints respond to health check messages
  • pathsAliasWorkflow - TypeScript path aliases resolve correctly
  • Calculator.calculate - static workflow method using static step methods from another class
  • AllInOneService.processNumber - static workflow method using sibling static step methods
  • ChainableService.processWithThis - static step methods using this to reference the class
  • thisSerializationWorkflow - step function invoked with .call() and .apply()
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • stepFunctionAsStartArgWorkflow - step function reference passed as start() argument
  • cancelRun - cancelling a running workflow
  • cancelRun via CLI - cancelling a running workflow
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router
  • hookWithSleepWorkflow - hook payloads delivered correctly with concurrent sleep
  • sleepInLoopWorkflow - sleep inside loop with steps actually delays each iteration
  • sleepWithSequentialStepsWorkflow - sequential steps work with concurrent sleep (control)
Details by Category
✅ ▲ Vercel Production
AppPassedFailedSkipped
✅ astro6807
✅ example6807
✅ express6807
✅ fastify6807
✅ hono6807
✅ nextjs-turbopack7302
✅ nextjs-webpack7302
✅ nitro6807
✅ nuxt6807
✅ sveltekit6807
✅ vite6807
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack7203
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev302
❌ mongodb5233
✅ redis-dev302
❌ redis5323
✅ turso-dev302
❌ turso4513
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable6609
✅ e2e-local-postgres-nest-stable6609
✅ e2e-local-prod-nest-stable6609
📋 View full workflow run

This was referenced Jan 19, 2026
 Merged

 Merged

 Merged

@TooTallNateGraphite App
TooTallNate
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
This stack of pull requests is managed by Graphite. Learn more about stacking.

This was referenced Jan 19, 2026
 Merged

 Merged

@TooTallNate
TooTallNate
marked this pull request as ready for review
January 19, 2026 23:18
CopilotAI
review requested due to automatic review settings
January 19, 2026 23:18
@TooTallNate
TooTallNate
marked this pull request as draft
January 19, 2026 23:18
@vercel
vercelBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
example-nextjs-workflow-turbopackReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
example-nextjs-workflow-webpackReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
example-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-astro-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-express-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-fastify-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-hono-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-nitro-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-nuxt-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-sveltekit-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-vite-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-docsReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-nestReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-swc-playgroundReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
@TooTallNate
TooTallNateforce-pushed
the
01-19-add_documentation_for_custom_class_serialization
branch
from
cbe3550 to
9020264CompareJanuary 19, 2026 23:19
CopilotAI
reviewed
Jan 19, 2026
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
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 adds comprehensive documentation for the custom class serialization feature using the new @workflow/serde package. The documentation explains how developers can make their custom classes serializable in workflows by implementing WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols.
Changes:
  • Added a new "Custom Class Serialization" section to the serialization documentation with examples showing basic and complex usage patterns
  • Updated the docs-typecheck extractor to support MDX-style comments for @expect-error annotations in addition to HTML comments
  • Added the @workflow/serde package to the API reference navigation and index
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
FileDescription
packages/docs-typecheck/src/extractor.tsEnhanced regex to support both HTML and MDX comment formats for @expect-error annotations
docs/content/docs/foundations/serialization.mdxAdded comprehensive documentation section explaining custom class serialization with code examples
docs/content/docs/api-reference/meta.jsonAdded workflow-serde to the API reference pages list
docs/content/docs/api-reference/index.mdxAdded Card component linking to the @workflow/serde package documentation
.changeset/smooth-nails-do.mdEmpty changeset file (acceptable for documentation-only changes)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
@TooTallNate
TooTallNateforce-pushed
the
01-19-add_documentation_for_custom_class_serialization
branch
from
199d665 to
feb442fCompareMarch 10, 2026 21:27
@TooTallNate
Merge branch 'main' into 01-19-add_documentation_for_custom_class_ser…
a039439
…ialization
@TooTallNate
Merge branch 'main' of github.com:vercel/workflow into 01-19-add_docu…
1e6ec66
…mentation_for_custom_class_serialization
@TooTallNate
Enhance serialization docs: custom class examples with 'use step' ins…
7bf8785
…tance methods
- Add custom classes to Supported Serializable Types with anchor link
- Replace verbose parenthetical in Requirements with back-link
- Add [!code highlight] to Basic Example serde methods
- Simplify geometry.ts to import Point instead of redefining it
- Rewrite Complex Example to demonstrate 'use step' on instance methods
with realistic APIs (database, HTTP) and contrast with workflow-context methods
- Add pass-by-value note for 'this' context with return-and-reassign pattern
@TooTallNate
Fix docs typecheck: use correct @expect-error codes for Order examples
2946474
@TooTallNate
Fix pre-existing docs typecheck failures in workflow-serde API reference
81c671e
Add @skip-typecheck to bare static method signatures that aren't valid
standalone TypeScript.
VaguelySerious
VaguelySerious
approved these changes
Mar 17, 2026
View reviewed changes
Comment threadpackages/docs-typecheck/src/extractor.ts
const CODE_BLOCK_REGEX =
 /```(typescript|ts|javascript|js)(?:[^\S\n]+[^\n]*)?\n([\s\S]*?)```/g;
const EXPECT_ERROR_REGEX = /<!--\s*@expect-error:([0-9,\s]+)\s*-->/;
// Support both HTML comments (<!-- @expect-error:2351 -->) and MDX comments ({/* @expect-error:2351 */})
@VaguelySeriousVaguelySeriousMar 17, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

what is this change for?
@TooTallNateTooTallNateMar 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The @expect-error marker only supported HTML comment syntax (<!-- @expect-error:2351 -->), which was sufficient since the only prior usage was in a .md file (the docs-typecheck README). However, MDX files do not support HTML comments — the MDX parser rejects <!-- with "Unexpected character !". Since the serialization docs are .mdx files and need @expect-error markers, this adds support for the MDX comment syntax ({/* @expect-error:2351 */}) as an alternative. The @skip-typecheck marker already supported both formats.
@TooTallNate
Revert extractor changes, use HTML comments for @expect-error markers
330ebcf
The docs typecheck extractor only supports HTML comment syntax for
@expect-error on main. Use <!-- @expect-error:XXXX --> instead of
{/* @expect-error:XXXX */} to match the existing convention.
@TooTallNate
Use MDX comment syntax for @expect-error markers, add MDX support to …
9830710
…extractor
MDX files don't support HTML comments (<!-- -->). The extractor's
@expect-error regex only supported HTML syntax, but @skip-typecheck
already supported both. This aligns @expect-error to also support
the MDX comment syntax ({/* @expect-error:XXXX */}).
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

Copilot code reviewCopilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@VaguelySeriousVaguelySeriousVaguelySerious approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@TooTallNate@VaguelySerious

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Add documentation for custom class serialization by TooTallNate · Pull Request #810 · vercel/workflow · GitHub
Skip to content
Add documentation for custom class serialization - #810
Merged
TooTallNate merged 8 commits into
mainfrom 
01-19-add_documentation_for_custom_class_serialization
Mar 18, 2026
Merged
Add documentation for custom class serialization#810
TooTallNate merged 8 commits into
mainfrom 
01-19-add_documentation_for_custom_class_serialization
Conversation
@TooTallNate
@TooTallNateTooTallNate
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Member
Added documentation for custom class serialization in workflows with new @workflow/serde package.
What changed?
  • Added documentation for the new @workflow/serde package that provides serialization symbols for custom class serialization
  • Added a new section to the serialization docs explaining how to make custom classes serializable
  • Added the @workflow/serde package to the API reference navigation
  • Updated the docs-typecheck extractor to support MDX comments for expect-error annotations
Why make this change?
Custom class serialization is an important feature for workflows that need to work with complex data structures. This documentation explains how developers can make their own classes serializable using the WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols from the new @workflow/serde package, enabling seamless passing of class instances between workflow and step functions.
@changeset-bot
changeset-botBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 9830710
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@github-actions
github-actionsBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
🧪 E2E Test Results
❌ Some tests failed
Summary
PassedFailedSkippedTotal
✅ ▲ Vercel Production758067825
✅ 💻 Local Development7820118900
✅ 📦 Local Production7820118900
✅ 🐘 Local Postgres7820118900
✅ 🪟 Windows720375
❌ 🌍 Community Worlds1185615189
✅ 📋 Other198027225
Total3492564664014
❌ Failed Tests
🌍 Community Worlds (56 failed)
mongodb (3 failed):
  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
redis (2 failed):
  • hookWorkflow is not resumable via public webhook endpoint
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
turso (51 failed):
  • addTenWorkflow
  • addTenWorkflow
  • wellKnownAgentWorkflow (.well-known/agent)
  • should work with react rendering in step
  • promiseAllWorkflow
  • promiseRaceWorkflow
  • promiseAnyWorkflow
  • importedStepOnlyWorkflow
  • hookWorkflow
  • hookWorkflow is not resumable via public webhook endpoint
  • webhookWorkflow
  • sleepingWorkflow
  • parallelSleepWorkflow
  • nullByteWorkflow
  • workflowAndStepMetadataWorkflow
  • fetchWorkflow
  • promiseRaceStressTestWorkflow
  • error handling error propagation workflow errors nested function calls preserve message and stack trace
  • error handling error propagation workflow errors cross-file imports preserve message and stack trace
  • error handling error propagation step errors basic step error preserves message and stack trace
  • error handling error propagation step errors cross-file step error preserves message and function names in stack
  • error handling retry behavior regular Error retries until success
  • error handling retry behavior FatalError fails immediately without retries
  • error handling retry behavior RetryableError respects custom retryAfter delay
  • error handling retry behavior maxRetries=0 disables retries
  • error handling catchability FatalError can be caught and detected with FatalError.is()
  • hookCleanupTestWorkflow - hook token reuse after workflow completion
  • concurrent hook token conflict - two workflows cannot use the same hook token simultaneously
  • hookDisposeTestWorkflow - hook token reuse after explicit disposal while workflow still running
  • stepFunctionPassingWorkflow - step function references can be passed as arguments (without closure vars)
  • stepFunctionWithClosureWorkflow - step function with closure variables passed as argument
  • closureVariableWorkflow - nested step functions with closure variables
  • spawnWorkflowFromStepWorkflow - spawning a child workflow using start() inside a step
  • health check (queue-based) - workflow and step endpoints respond to health check messages
  • pathsAliasWorkflow - TypeScript path aliases resolve correctly
  • Calculator.calculate - static workflow method using static step methods from another class
  • AllInOneService.processNumber - static workflow method using sibling static step methods
  • ChainableService.processWithThis - static step methods using this to reference the class
  • thisSerializationWorkflow - step function invoked with .call() and .apply()
  • customSerializationWorkflow - custom class serialization with WORKFLOW_SERIALIZE/WORKFLOW_DESERIALIZE
  • instanceMethodStepWorkflow - instance methods with "use step" directive
  • crossContextSerdeWorkflow - classes defined in step code are deserializable in workflow context
  • stepFunctionAsStartArgWorkflow - step function reference passed as start() argument
  • cancelRun - cancelling a running workflow
  • cancelRun via CLI - cancelling a running workflow
  • pages router addTenWorkflow via pages router
  • pages router promiseAllWorkflow via pages router
  • pages router sleepingWorkflow via pages router
  • hookWithSleepWorkflow - hook payloads delivered correctly with concurrent sleep
  • sleepInLoopWorkflow - sleep inside loop with steps actually delays each iteration
  • sleepWithSequentialStepsWorkflow - sequential steps work with concurrent sleep (control)
Details by Category
✅ ▲ Vercel Production
AppPassedFailedSkipped
✅ astro6807
✅ example6807
✅ express6807
✅ fastify6807
✅ hono6807
✅ nextjs-turbopack7302
✅ nextjs-webpack7302
✅ nitro6807
✅ nuxt6807
✅ sveltekit6807
✅ vite6807
✅ 💻 Local Development
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 📦 Local Production
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 🐘 Local Postgres
AppPassedFailedSkipped
✅ astro-stable6609
✅ express-stable6609
✅ fastify-stable6609
✅ hono-stable6609
✅ nextjs-turbopack-canary55020
✅ nextjs-turbopack-stable7203
✅ nextjs-webpack-canary55020
✅ nextjs-webpack-stable7203
✅ nitro-stable6609
✅ nuxt-stable6609
✅ sveltekit-stable6609
✅ vite-stable6609
✅ 🪟 Windows
AppPassedFailedSkipped
✅ nextjs-turbopack7203
❌ 🌍 Community Worlds
AppPassedFailedSkipped
✅ mongodb-dev302
❌ mongodb5233
✅ redis-dev302
❌ redis5323
✅ turso-dev302
❌ turso4513
✅ 📋 Other
AppPassedFailedSkipped
✅ e2e-local-dev-nest-stable6609
✅ e2e-local-postgres-nest-stable6609
✅ e2e-local-prod-nest-stable6609
📋 View full workflow run

This was referenced Jan 19, 2026
 Merged

 Merged

 Merged

@TooTallNateGraphite App
TooTallNate
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
This stack of pull requests is managed by Graphite. Learn more about stacking.

This was referenced Jan 19, 2026
 Merged

 Merged

@TooTallNate
TooTallNate
marked this pull request as ready for review
January 19, 2026 23:18
CopilotAI
review requested due to automatic review settings
January 19, 2026 23:18
@TooTallNate
TooTallNate
marked this pull request as draft
January 19, 2026 23:18
@vercel
vercelBot
commented
Jan 19, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
example-nextjs-workflow-turbopackReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
example-nextjs-workflow-webpackReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
example-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-astro-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-express-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-fastify-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-hono-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-nitro-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-nuxt-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-sveltekit-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workbench-vite-workflowReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-docsReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-nestReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
workflow-swc-playgroundReadyReadyPreview, Comment, Open in v0Mar 17, 2026 11:53pm
@TooTallNate
TooTallNateforce-pushed
the
01-19-add_documentation_for_custom_class_serialization
branch
from
cbe3550 to
9020264CompareJanuary 19, 2026 23:19
CopilotAI
reviewed
Jan 19, 2026
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
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 adds comprehensive documentation for the custom class serialization feature using the new @workflow/serde package. The documentation explains how developers can make their custom classes serializable in workflows by implementing WORKFLOW_SERIALIZE and WORKFLOW_DESERIALIZE symbols.
Changes:
  • Added a new "Custom Class Serialization" section to the serialization documentation with examples showing basic and complex usage patterns
  • Updated the docs-typecheck extractor to support MDX-style comments for @expect-error annotations in addition to HTML comments
  • Added the @workflow/serde package to the API reference navigation and index
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
FileDescription
packages/docs-typecheck/src/extractor.tsEnhanced regex to support both HTML and MDX comment formats for @expect-error annotations
docs/content/docs/foundations/serialization.mdxAdded comprehensive documentation section explaining custom class serialization with code examples
docs/content/docs/api-reference/meta.jsonAdded workflow-serde to the API reference pages list
docs/content/docs/api-reference/index.mdxAdded Card component linking to the @workflow/serde package documentation
.changeset/smooth-nails-do.mdEmpty changeset file (acceptable for documentation-only changes)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
@TooTallNate
TooTallNateforce-pushed
the
01-19-add_documentation_for_custom_class_serialization
branch
from
199d665 to
feb442fCompareMarch 10, 2026 21:27
@TooTallNate
Merge branch 'main' into 01-19-add_documentation_for_custom_class_ser…
a039439
…ialization
@TooTallNate
Merge branch 'main' of github.com:vercel/workflow into 01-19-add_docu…
1e6ec66
…mentation_for_custom_class_serialization
@TooTallNate
Enhance serialization docs: custom class examples with 'use step' ins…
7bf8785
…tance methods
- Add custom classes to Supported Serializable Types with anchor link
- Replace verbose parenthetical in Requirements with back-link
- Add [!code highlight] to Basic Example serde methods
- Simplify geometry.ts to import Point instead of redefining it
- Rewrite Complex Example to demonstrate 'use step' on instance methods
with realistic APIs (database, HTTP) and contrast with workflow-context methods
- Add pass-by-value note for 'this' context with return-and-reassign pattern
@TooTallNate
Fix docs typecheck: use correct @expect-error codes for Order examples
2946474
@TooTallNate
Fix pre-existing docs typecheck failures in workflow-serde API reference
81c671e
Add @skip-typecheck to bare static method signatures that aren't valid
standalone TypeScript.
VaguelySerious
VaguelySerious
approved these changes
Mar 17, 2026
View reviewed changes
Comment threadpackages/docs-typecheck/src/extractor.ts
const CODE_BLOCK_REGEX =
 /```(typescript|ts|javascript|js)(?:[^\S\n]+[^\n]*)?\n([\s\S]*?)```/g;
const EXPECT_ERROR_REGEX = /<!--\s*@expect-error:([0-9,\s]+)\s*-->/;
// Support both HTML comments (<!-- @expect-error:2351 -->) and MDX comments ({/* @expect-error:2351 */})
@VaguelySeriousVaguelySeriousMar 17, 2026

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

what is this change for?
@TooTallNateTooTallNateMar 17, 2026

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The @expect-error marker only supported HTML comment syntax (<!-- @expect-error:2351 -->), which was sufficient since the only prior usage was in a .md file (the docs-typecheck README). However, MDX files do not support HTML comments — the MDX parser rejects <!-- with "Unexpected character !". Since the serialization docs are .mdx files and need @expect-error markers, this adds support for the MDX comment syntax ({/* @expect-error:2351 */}) as an alternative. The @skip-typecheck marker already supported both formats.
@TooTallNate
Revert extractor changes, use HTML comments for @expect-error markers
330ebcf
The docs typecheck extractor only supports HTML comment syntax for
@expect-error on main. Use <!-- @expect-error:XXXX --> instead of
{/* @expect-error:XXXX */} to match the existing convention.
@TooTallNate
Use MDX comment syntax for @expect-error markers, add MDX support to …
9830710
…extractor
MDX files don't support HTML comments (<!-- -->). The extractor's
@expect-error regex only supported HTML syntax, but @skip-typecheck
already supported both. This aligns @expect-error to also support
the MDX comment syntax ({/* @expect-error:XXXX */}).
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

Copilot code reviewCopilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@VaguelySeriousVaguelySeriousVaguelySerious approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@TooTallNate@VaguelySerious