@wp-playground/client 0.5.3 → 0.5.5
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.
- package/README.md +3 -3
- package/index.cjs +76 -94
- package/index.d.ts +0 -1
- package/index.js +1388 -1436
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Playground Client
|
|
2
2
|
|
|
3
|
-
Provides a [PlaygroundClient](https://wordpress.github.io/wordpress-playground/
|
|
3
|
+
Provides a [PlaygroundClient](https://wordpress.github.io/wordpress-playground/api/client/) that can be used to control a WordPress Playground iframe:
|
|
4
4
|
|
|
5
5
|
```ts
|
|
6
6
|
import { startPlaygroundWeb } from '@wp-playground/client';
|
|
@@ -20,7 +20,7 @@ console.log(response.text);
|
|
|
20
20
|
|
|
21
21
|
Using TypeScript is highly recommended as this package ships with comprehensive types – hit ctrl+space in your IDE after `client.` and you'll see all the available methods.
|
|
22
22
|
|
|
23
|
-
Once you have a [PlaygroundClient](https://wordpress.github.io/wordpress-playground/
|
|
23
|
+
Once you have a [PlaygroundClient](https://wordpress.github.io/wordpress-playground/api/client/) instance, you can use it to control the playground:
|
|
24
24
|
|
|
25
25
|
```ts
|
|
26
26
|
await client.writeFile('/index.php', '<?php echo "Hi!"; ');
|
|
@@ -39,4 +39,4 @@ await client.request({
|
|
|
39
39
|
});
|
|
40
40
|
```
|
|
41
41
|
|
|
42
|
-
To see all the available methods, check out the [PlaygroundClient](https://wordpress.github.io/wordpress-playground/
|
|
42
|
+
To see all the available methods, check out the [PlaygroundClient](https://wordpress.github.io/wordpress-playground/api/client/) interface.
|