Skip to content

Conversation

@Crazelu
Copy link
Contributor

@Crazelu Crazelu commented Jan 8, 2026

Adds documentation for the type-safe code generated interface for future calls.

Closes: serverpod/serverpod#4607

@Crazelu
Copy link
Contributor Author

Crazelu commented Jan 8, 2026

@marcelomendoncasoares here's the PR for the future calls docs

Copy link
Collaborator

@marcelomendoncasoares marcelomendoncasoares left a comment

Choose a reason for hiding this comment

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

Thanks for the quick PR on the docs, @Crazelu! I have left a few guidelines about the experience we aim with docs on the comments, and also some improvement/fixes suggestions.

Beyond these, I missed a reference on the usage of abstract to declare future calls in modules, that users can extend in their own projects - since there is no way for users to mixture the ones generated in the module with their own. We should also present the support for inheritance of future calls in itself.

Another extra page that is worth adding is Recurring tasks to show how to achieve a cron-like scheduling. The current recommended way is by scheduling a future call inside another - at the start, for example. With generated future calls, though, it will probably be a two step operation or require the creation of two separate future calls: one for the unit execution, the other for invoking the first twice (now and next) to make it recurrent.

@marcelomendoncasoares

This comment was marked as resolved.

@Crazelu

This comment was marked as resolved.

@marcelomendoncasoares

This comment was marked as resolved.

@Crazelu

This comment was marked as resolved.

@Crazelu
Copy link
Contributor Author

Crazelu commented Jan 19, 2026

@marcelomendoncasoares the docs are updated now

Copy link
Collaborator

@marcelomendoncasoares marcelomendoncasoares left a comment

Choose a reason for hiding this comment

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

Excellent work on the docs, @Crazelu! Just two small details and we are good to go 🚀

Copy link
Collaborator

@marcelomendoncasoares marcelomendoncasoares left a comment

Choose a reason for hiding this comment

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

Great work, @Crazelu!!

Now we just need to merge main and copy the new docs to the versioned_docs/version-3.2.0 path, so it gets updated in the versioned docs.

@marcelomendoncasoares marcelomendoncasoares force-pushed the feat/type-safe-future-calls branch from 7073ea1 to 34323f1 Compare January 20, 2026 15:26
@marcelomendoncasoares marcelomendoncasoares merged commit 15a49b7 into serverpod:main Jan 20, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Future calls new API doc is missing

2 participants