@wp-playground/client 3.1.26 → 3.1.28

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/index.cjs +9 -9
  2. package/index.d.ts +21 -0
  3. package/index.js +388 -382
  4. package/package.json +2 -2
package/index.d.ts CHANGED
@@ -5270,6 +5270,7 @@ export type WorkerBootOptions = {
5270
5270
  withNetworking: boolean;
5271
5271
  mounts?: Array<MountDescriptor>;
5272
5272
  shouldInstallWordPress?: boolean;
5273
+ shouldBootWordPress?: boolean;
5273
5274
  corsProxyUrl?: string;
5274
5275
  /** When true, skip default WP install and run Blueprints v2 in the worker */
5275
5276
  experimentalBlueprintsV2Runner?: boolean;
@@ -5444,7 +5445,27 @@ export interface StartPlaygroundOptions {
5444
5445
  */
5445
5446
  sapiName?: string;
5446
5447
  mounts?: Array<MountDescriptor>;
5448
+ /**
5449
+ * Whether to download/install WordPress files.
5450
+ *
5451
+ * Set this to `false` when WordPress files are already available, for example
5452
+ * from `mounts` or a saved site.
5453
+ *
5454
+ * This option cannot be set to `true` when `shouldBootWordPress` is `false`,
5455
+ * because installing WordPress requires running the WordPress boot setup.
5456
+ */
5447
5457
  shouldInstallWordPress?: boolean;
5458
+ /**
5459
+ * Whether to run WordPress boot setup.
5460
+ *
5461
+ * This is separate from `shouldInstallWordPress` because saved sites can boot
5462
+ * from existing WordPress files without downloading or installing a fresh copy.
5463
+ * Set this to `false` for PHP-only Playgrounds.
5464
+ *
5465
+ * If `shouldInstallWordPress` is `false` and this option is `true`, WordPress
5466
+ * files must already be present, for example via `mounts` or a saved site.
5467
+ */
5468
+ shouldBootWordPress?: boolean;
5448
5469
  /**
5449
5470
  * The string prefix used in the site URL served by the currently
5450
5471
  * running remote.html. E.g. for a prefix like `/scope:playground/`,