sveltejs / sveltejs/kit

Mention background workers in documentation

Open
#14,375 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
JavaScript
Stars
20.8k
Forks
2.3k
Avg merge
1d 16h
Merged PRs (30d)
156

Description

Describe the problem

I've opened a similar discussion thread before, but this time I wanted to propose to do more a bit.
So, one of the main strengths of SvelteKit for me is that I can have my backend and frontend in the same repository. It gets more complicated though, when there is a need to do some work in the background.
SvelteKit doesn't really support anything out of the box yet, and this is understandable - it's not a priority yet and there is only so much you can focus on at once.

Describe the proposed solution

As a workaround solution, would it be possible to add a section to documentation, explaining how to implement background tasks in the SvelteKit ecosystem? Let's say in the Project types page. Currently the easiest solution is to use the vite-node package.

Alternatives considered

No response

Importance

nice to have

Additional Information

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the SvelteKit documentation's Project types page and review the linked discussion thread 9807, along with discussion 12927, for the proposed background-task guidance. Add a section explaining how to implement background tasks in the SvelteKit ecosystem using the documented workaround, vite-node, and verify that the guidance is clear and complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.