feat: v0.3.3

Author: ZhiXiao-Lin

README.md

@@ -13,7 +13,8 @@ yarn add nerdctl
 ```ts
 import { events, factory } from "nerdctl";
 
-const IMAGE = "hello-world";
+const IMAGE_NAME = "hello-world";
+const CONTAINER_NAME = "hello";
 
 const vm = factory();
 if (!(await vm.checkVM())) {
@@ -27,17 +28,18 @@ vm.on(events.IMAGE_PULL_OUTPUT, (data) => {
 vm.on(events.IMAGE_PULL_END, (data) => {
   console.log(data);
 });
-
 vm.on(events.CONTAINER_RUN_OUTPUT, (data) => {
   console.log(data);
 });
 
-await vm.pullImage(IMAGE);
+await vm.pullImage(IMAGE_NAME);
 
 const images = await vm.getImages();
 console.log(images);
 
-await vm.run(IMAGE, { rm: true });
+await vm.run(IMAGE_NAME, { name: CONTAINER_NAME });
+await vm.stop(CONTAINER_NAME);
+await vm.remove(CONTAINER_NAME);
 ```
 
 ## License

docs/assets/search.js

@@ -13,7 +13,7 @@ <h1>Install</h1>
 <a href="#useage" id="useage" style="color: inherit; text-decoration: none;">
   <h1>Useage</h1>
 </a>
-<pre><code class="language-ts"><span class="hl-1">import</span><span class="hl-0"> { </span><span class="hl-2">events</span><span class="hl-0">, </span><span class="hl-2">factory</span><span class="hl-0"> } </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">&quot;nerdctl&quot;</span><span class="hl-0">;</span><br/><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">IMAGE</span><span class="hl-0"> = </span><span class="hl-3">&quot;hello-world&quot;</span><span class="hl-0">;</span><br/><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">vm</span><span class="hl-0"> = </span><span class="hl-6">factory</span><span class="hl-0">();</span><br/><span class="hl-1">if</span><span class="hl-0"> (!(</span><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">checkVM</span><span class="hl-0">())) {</span><br/><span class="hl-0">  </span><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">initVM</span><span class="hl-0">();</span><br/><span class="hl-0">}</span><br/><br/><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">on</span><span class="hl-0">(</span><span class="hl-2">events</span><span class="hl-0">.</span><span class="hl-5">IMAGE_PULL_START</span><span class="hl-0">, () </span><span class="hl-4">=&gt;</span><span class="hl-0"> {});</span><br/><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">on</span><span class="hl-0">(</span><span class="hl-2">events</span><span class="hl-0">.</span><span class="hl-5">IMAGE_PULL_OUTPUT</span><span class="hl-0">, (</span><span class="hl-2">data</span><span class="hl-0">) </span><span class="hl-4">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0">  </span><span class="hl-2">console</span><span class="hl-0">.</span><span class="hl-6">log</span><span class="hl-0">(</span><span class="hl-2">data</span><span class="hl-0">);</span><br/><span class="hl-0">});</span><br/><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">on</span><span class="hl-0">(</span><span class="hl-2">events</span><span class="hl-0">.</span><span class="hl-5">IMAGE_PULL_END</span><span class="hl-0">, (</span><span class="hl-2">data</span><span class="hl-0">) </span><span class="hl-4">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0">  </span><span class="hl-2">console</span><span class="hl-0">.</span><span class="hl-6">log</span><span class="hl-0">(</span><span class="hl-2">data</span><span class="hl-0">);</span><br/><span class="hl-0">});</span><br/><br/><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">pullImage</span><span class="hl-0">(</span><span class="hl-5">IMAGE</span><span class="hl-0">);</span><br/><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">images</span><span class="hl-0"> = </span><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">getImages</span><span class="hl-0">();</span><br/><span class="hl-2">console</span><span class="hl-0">.</span><span class="hl-6">log</span><span class="hl-0">(</span><span class="hl-2">images</span><span class="hl-0">);</span><br/><br/><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">run</span><span class="hl-0">(</span><span class="hl-5">IMAGE</span><span class="hl-0">, { </span><span class="hl-2">rm:</span><span class="hl-0"> </span><span class="hl-4">true</span><span class="hl-0"> });</span>
+<pre><code class="language-ts"><span class="hl-1">import</span><span class="hl-0"> { </span><span class="hl-2">events</span><span class="hl-0">, </span><span class="hl-2">factory</span><span class="hl-0"> } </span><span class="hl-1">from</span><span class="hl-0"> </span><span class="hl-3">&quot;nerdctl&quot;</span><span class="hl-0">;</span><br/><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">IMAGE_NAME</span><span class="hl-0"> = </span><span class="hl-3">&quot;hello-world&quot;</span><span class="hl-0">;</span><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">CONTAINER_NAME</span><span class="hl-0"> = </span><span class="hl-3">&quot;hello&quot;</span><span class="hl-0">;</span><br/><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">vm</span><span class="hl-0"> = </span><span class="hl-6">factory</span><span class="hl-0">();</span><br/><span class="hl-1">if</span><span class="hl-0"> (!(</span><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">checkVM</span><span class="hl-0">())) {</span><br/><span class="hl-0">  </span><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">initVM</span><span class="hl-0">();</span><br/><span class="hl-0">}</span><br/><br/><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">on</span><span class="hl-0">(</span><span class="hl-2">events</span><span class="hl-0">.</span><span class="hl-5">IMAGE_PULL_START</span><span class="hl-0">, () </span><span class="hl-4">=&gt;</span><span class="hl-0"> {});</span><br/><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">on</span><span class="hl-0">(</span><span class="hl-2">events</span><span class="hl-0">.</span><span class="hl-5">IMAGE_PULL_OUTPUT</span><span class="hl-0">, (</span><span class="hl-2">data</span><span class="hl-0">) </span><span class="hl-4">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0">  </span><span class="hl-2">console</span><span class="hl-0">.</span><span class="hl-6">log</span><span class="hl-0">(</span><span class="hl-2">data</span><span class="hl-0">);</span><br/><span class="hl-0">});</span><br/><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">on</span><span class="hl-0">(</span><span class="hl-2">events</span><span class="hl-0">.</span><span class="hl-5">IMAGE_PULL_END</span><span class="hl-0">, (</span><span class="hl-2">data</span><span class="hl-0">) </span><span class="hl-4">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0">  </span><span class="hl-2">console</span><span class="hl-0">.</span><span class="hl-6">log</span><span class="hl-0">(</span><span class="hl-2">data</span><span class="hl-0">);</span><br/><span class="hl-0">});</span><br/><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">on</span><span class="hl-0">(</span><span class="hl-2">events</span><span class="hl-0">.</span><span class="hl-5">CONTAINER_RUN_OUTPUT</span><span class="hl-0">, (</span><span class="hl-2">data</span><span class="hl-0">) </span><span class="hl-4">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0">  </span><span class="hl-2">console</span><span class="hl-0">.</span><span class="hl-6">log</span><span class="hl-0">(</span><span class="hl-2">data</span><span class="hl-0">);</span><br/><span class="hl-0">});</span><br/><br/><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">pullImage</span><span class="hl-0">(</span><span class="hl-5">IMAGE_NAME</span><span class="hl-0">);</span><br/><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">images</span><span class="hl-0"> = </span><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">getImages</span><span class="hl-0">();</span><br/><span class="hl-2">console</span><span class="hl-0">.</span><span class="hl-6">log</span><span class="hl-0">(</span><span class="hl-2">images</span><span class="hl-0">);</span><br/><br/><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">run</span><span class="hl-0">(</span><span class="hl-5">IMAGE_NAME</span><span class="hl-0">, { </span><span class="hl-2">name:</span><span class="hl-0"> </span><span class="hl-5">CONTAINER_NAME</span><span class="hl-0"> });</span><br/><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">stop</span><span class="hl-0">(</span><span class="hl-5">CONTAINER_NAME</span><span class="hl-0">);</span><br/><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-2">vm</span><span class="hl-0">.</span><span class="hl-6">remove</span><span class="hl-0">(</span><span class="hl-5">CONTAINER_NAME</span><span class="hl-0">);</span>
 </code></pre>
 
 <a href="#license" id="license" style="color: inherit; text-decoration: none;">