Config documentation improvements #866
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dobesv
commented
Mar 17, 2025
| @@ -79,7 +79,7 @@ export class WorkerRunner implements TargetRunner { | |||
| const scriptFile = target.options?.worker ?? target.options?.script; | |||
|
|
|||
| if (!scriptFile) { | |||
| throw new Error('WorkerRunner: "script" configuration is required - e.g. { type: "worker", script: "./worker.js" }'); | |||
| throw new Error('WorkerRunner: "worker" configuration is required - e.g. { type: "worker", options: { worker: "path/to/worker.js" } }'); | |||
There was a problem hiding this comment.
Updated this message since it seems like "worker" is the preferred key name now per the examples already provided in the docs.
dobesv
force-pushed
the
config-docs-improvements
branch
3 times, most recently
from
d1c3ab6 to
00c560a
Compare
There are a lot of features and options that are not described on the website, and can only be found be perusing the source code. This attempts to add some of that to the docs in the reference page.
dobesv
force-pushed
the
config-docs-improvements
branch
from
00c560a to
020701e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There are a lot of features and options that are not described on the website, and can only be found be perusing the source code. This attempts to add some of that to the docs in the reference page.