Skip to content

Commit 19e7b87

Browse files
authored
chore(SwingSet): Document ManagerType values (#11371)
From Slack: > bummer there isn't more documentation attached to those enumeration values
1 parent 7a15f90 commit 19e7b87

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

packages/SwingSet/src/types-external.js

+5
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@ export {};
3838

3939
/**
4040
* @typedef { 'local' | 'node-subprocess' | 'xsnap' | 'xs-worker' } ManagerType
41+
* The type of worker for hosting a vat.
42+
* - **local**: a Compartment in the SwingSet Node.js process
43+
* - **node-subprocess**: a child process using the same Node.js executable
44+
* (`process.execPath`)
45+
* - **xsnap** or **xs-worker**: an {@link @agoric/xsnap! @agoric/xsnap} worker
4146
*/
4247

4348
/**

0 commit comments

Comments
 (0)