Skip to content
New issue

Have a question about this project?Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of serviceand privacy statement.We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📚 Documentation: Async Function documentation needs clearer explanation and examples #8382

Open
2 tasks done
sonicvizopened this issue Jul 12, 2024 · 0 comments
Open
2 tasks done
Labels
product / docs Fixes and upgrades for the Appwrite Docs. product / functions Fixes and upgrades for the Appwrite Functions.

Comments

@sonicviz
Copy link

💭 Description

Ref:
https://appwrite.io/docs/references/cloud/client-web/functions#createExecution
async
boolean
Execute code in the background. Default value is false.

Currently functions timeout after 30 seconds if async = false.
So while client code can async wait on a synch function call up to 30 seconds, there are many tasks that will need full async async execution longer than this, such as LLM RAG, emerging GraphRAG, and whatever evolution delivers in this space (as one example).
image

However, there is no clear concise explanation of the structure of a proper async function that I can find.
The template examples all seem to be built around async = false (30 second timeouts) so a clear concise explanation of the server side async support + some working cloud function example code to demonstrate best practice execution would be great.

It ultimately makes AW a better product having clear concise docs and a smooth developer UX for fast application development.
Also easier from a support perspective when people ask about it just to say sure, here's a link, have at it!

ty.

👀 Have you spent some time to check if this issue has been raised before?

  • I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

@stnguyen90 stnguyen90 changed the title Async Function documentation needs clearer explanation and examples📚 Documentation: 📚 Documentation: Async Function documentation needs clearer explanation and examples Jul 12, 2024
@stnguyen90 stnguyen90 added product / functions Fixes and upgrades for the Appwrite Functions. product / docs Fixes and upgrades for the Appwrite Docs. labels Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product / docs Fixes and upgrades for the Appwrite Docs. product / functions Fixes and upgrades for the Appwrite Functions.
Projects
None yet
Development

No branches or pull requests

2 participants