@molecule/api-code-sandbox-docker 1.1.3 → 1.1.4
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 +13 -1
- package/dist/index.d.ts +11 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +11 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@ AUTO-GENERATED — DO NOT EDIT THIS FILE.
|
|
|
3
3
|
Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
|
|
4
4
|
Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
|
|
5
5
|
To change this document, edit the module-level JSDoc in src/index.ts.
|
|
6
|
-
Generated: 2026-
|
|
6
|
+
Generated: 2026-10-01T18:20:54.762Z
|
|
7
7
|
-->
|
|
8
8
|
|
|
9
9
|
# @molecule/api-code-sandbox-docker
|
|
@@ -14,6 +14,18 @@ Generated: 2026-09-18T06:33:40.632Z
|
|
|
14
14
|
|
|
15
15
|
Docker code-sandbox provider for molecule.dev.
|
|
16
16
|
|
|
17
|
+
## Quick Start
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { setProvider } from '@molecule/api-code-sandbox'
|
|
21
|
+
import { provider } from '@molecule/api-code-sandbox-docker'
|
|
22
|
+
|
|
23
|
+
setProvider(provider) // at startup
|
|
24
|
+
// Reaches the daemon at /var/run/docker.sock (DOCKER_SOCKET_PATH / DOCKER_HOST).
|
|
25
|
+
// The base image (default node:22-slim) must already exist on the host — it
|
|
26
|
+
// is never pulled.
|
|
27
|
+
```
|
|
28
|
+
|
|
17
29
|
## Type
|
|
18
30
|
|
|
19
31
|
`provider`
|
package/dist/index.d.ts
CHANGED
|
@@ -77,6 +77,17 @@
|
|
|
77
77
|
* `admits` is always `null`: Docker has no quota of its own to consult, so the
|
|
78
78
|
* floors and the refusal stay with the caller.
|
|
79
79
|
*
|
|
80
|
+
* @example
|
|
81
|
+
* ```typescript
|
|
82
|
+
* import { setProvider } from '@molecule/api-code-sandbox'
|
|
83
|
+
* import { provider } from '@molecule/api-code-sandbox-docker'
|
|
84
|
+
*
|
|
85
|
+
* setProvider(provider) // at startup
|
|
86
|
+
* // Reaches the daemon at /var/run/docker.sock (DOCKER_SOCKET_PATH / DOCKER_HOST).
|
|
87
|
+
* // The base image (default node:22-slim) must already exist on the host — it
|
|
88
|
+
* // is never pulled.
|
|
89
|
+
* ```
|
|
90
|
+
*
|
|
80
91
|
* @module
|
|
81
92
|
*/
|
|
82
93
|
export * from './browser-guard.js';
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2FG;AAEH,cAAc,oBAAoB,CAAA;AAClC,cAAc,eAAe,CAAA;AAC7B,cAAc,YAAY,CAAA;AAE1B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAMjE;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,eAUrB,CAAA"}
|
package/dist/index.js
CHANGED
|
@@ -77,6 +77,17 @@
|
|
|
77
77
|
* `admits` is always `null`: Docker has no quota of its own to consult, so the
|
|
78
78
|
* floors and the refusal stay with the caller.
|
|
79
79
|
*
|
|
80
|
+
* @example
|
|
81
|
+
* ```typescript
|
|
82
|
+
* import { setProvider } from '@molecule/api-code-sandbox'
|
|
83
|
+
* import { provider } from '@molecule/api-code-sandbox-docker'
|
|
84
|
+
*
|
|
85
|
+
* setProvider(provider) // at startup
|
|
86
|
+
* // Reaches the daemon at /var/run/docker.sock (DOCKER_SOCKET_PATH / DOCKER_HOST).
|
|
87
|
+
* // The base image (default node:22-slim) must already exist on the host — it
|
|
88
|
+
* // is never pulled.
|
|
89
|
+
* ```
|
|
90
|
+
*
|
|
80
91
|
* @module
|
|
81
92
|
*/
|
|
82
93
|
export * from './browser-guard.js';
|