Skip to content

Commit

Permalink
version 2.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@stagas
stagas committed Jun 28, 2022
1 parent d08c45b commit 18f755c
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<h1>
vite-open <a href="https://npmjs.org/package/vite-open"><img src="https://img.shields.io/badge/npm-v2.1.1-F00.svg?colorA=000"/></a> <a href="src"><img src="https://img.shields.io/badge/loc-296-FFF.svg?colorA=000"/></a> <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-F0B.svg?colorA=000"/></a>
vite-open <a href="https://npmjs.org/package/vite-open"><img src="https://img.shields.io/badge/npm-v2.2.0-F00.svg?colorA=000"/></a> <a href="src"><img src="https://img.shields.io/badge/loc-309-FFF.svg?colorA=000"/></a> <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-F0B.svg?colorA=000"/></a>
</h1>

<p></p>
Expand Down Expand Up @@ -35,7 +35,7 @@ Open any file directly in a Vite dev server.

## API

<p> <details id="ViteServer$23" title="Interface" ><summary><span><a href="#ViteServer$23">#</a></span> <code><strong>ViteServer</strong></code> &ndash; ViteServer return object.</summary> <a href="src/server.ts#L10">src/server.ts#L10</a> <ul> <p> <details id="localAddr$24" title="Property" ><summary><span><a href="#localAddr$24">#</a></span> <code><strong>localAddr</strong></code> &ndash; The local address</summary> <a href="src/server.ts#L12">src/server.ts#L12</a> <ul><p>string</p> </ul></details><details id="networkAddr$25" title="Property" ><summary><span><a href="#networkAddr$25">#</a></span> <code><strong>networkAddr</strong></code> &ndash; The network address</summary> <a href="src/server.ts#L14">src/server.ts#L14</a> <ul><p>string</p> </ul></details><details id="vite$26" title="Property" ><summary><span><a href="#vite$26">#</a></span> <code><strong>vite</strong></code> &ndash; The Vite dev server instance</summary> <a href="src/server.ts#L16">src/server.ts#L16</a> <ul><p><span>ViteDevServer</span></p> </ul></details><details id="log$27" title="Method" ><summary><span><a href="#log$27">#</a></span> <code><strong>log</strong></code><em>(args)</em> &ndash; Log function</summary> <a href="src/server.ts#L18">src/server.ts#L18</a> <ul> <p> <details id="args$29" title="Parameter" ><summary><span><a href="#args$29">#</a></span> <code><strong>args</strong></code> </summary> <ul><p>unknown []</p> </ul></details> <p><strong>log</strong><em>(args)</em> &nbsp;=&gt; <ul>void</ul></p></p> </ul></details></p></ul></details><details id="Options$1" title="Class" ><summary><span><a href="#Options$1">#</a></span> <code><strong>Options</strong></code> </summary> <a href="src/index.ts#L17">src/index.ts#L17</a> <ul> <p> <details id="constructor$2" title="Constructor" ><summary><span><a href="#constructor$2">#</a></span> <code><strong>constructor</strong></code><em>()</em> </summary> <ul> <p> <details id="new Options$3" title="ConstructorSignature" ><summary><span><a href="#new Options$3">#</a></span> <code><strong>new Options</strong></code><em>()</em> </summary> <ul><p><a href="#Options$1">Options</a></p> </ul></details></p> </ul></details><details id="file$8" title="Property" ><summary><span><a href="#file$8">#</a></span> <code><strong>file</strong></code> </summary> <a href="src/index.ts#L21">src/index.ts#L21</a> <ul><p>string</p> </ul></details><details id="https$10" title="Property" ><summary><span><a href="#https$10">#</a></span> <code><strong>https</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>false</code></span> </summary> <a href="src/index.ts#L27">src/index.ts#L27</a> <ul><p>boolean</p> </ul></details><details id="jsx$11" title="Property" ><summary><span><a href="#jsx$11">#</a></span> <code><strong>jsx</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>'react'</code></span> </summary> <a href="src/index.ts#L30">src/index.ts#L30</a> <ul><p>string</p> </ul></details><details id="log$4" title="Property" ><summary><span><a href="#log$4">#</a></span> <code><strong>log</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>defaultLog</code></span> </summary> <a href="src/index.ts#L18">src/index.ts#L18</a> <ul><p><details id="__type$5" title="Function" ><summary><span><a href="#__type$5">#</a></span> <em>(args)</em> </summary> <ul> <p> <details id="args$7" title="Parameter" ><summary><span><a href="#args$7">#</a></span> <code><strong>args</strong></code> </summary> <ul><p>unknown []</p> </ul></details> <p><strong></strong><em>(args)</em> &nbsp;=&gt; <ul>void</ul></p></p> </ul></details></p> </ul></details><details id="noOpen$12" title="Property" ><summary><span><a href="#noOpen$12">#</a></span> <code><strong>noOpen</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>false</code></span> </summary> <a href="src/index.ts#L33">src/index.ts#L33</a> <ul><p>boolean</p> </ul></details><details id="quiet$13" title="Property" ><summary><span><a href="#quiet$13">#</a></span> <code><strong>quiet</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>false</code></span> </summary> <a href="src/index.ts#L36">src/index.ts#L36</a> <ul><p>boolean</p> </ul></details><details id="responses$14" title="Property" ><summary><span><a href="#responses$14">#</a></span> <code><strong>responses</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>{}</code></span> </summary> <a href="src/index.ts#L38">src/index.ts#L38</a> <ul><p><span>Record</span>&lt;string, {<p> <details id="content$17" title="Property" ><summary><span><a href="#content$17">#</a></span> <code><strong>content</strong></code> </summary> <a href="src/index.ts#L38">src/index.ts#L38</a> <ul><p>string</p> </ul></details><details id="type$16" title="Property" ><summary><span><a href="#type$16">#</a></span> <code><strong>type</strong></code> </summary> <a href="src/index.ts#L38">src/index.ts#L38</a> <ul><p>string</p> </ul></details></p>}&gt;</p> </ul></details><details id="root$9" title="Property" ><summary><span><a href="#root$9">#</a></span> <code><strong>root</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>'.'</code></span> </summary> <a href="src/index.ts#L24">src/index.ts#L24</a> <ul><p>string</p> </ul></details><details id="viteOptions$18" title="Property" ><summary><span><a href="#viteOptions$18">#</a></span> <code><strong>viteOptions</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>{}</code></span> </summary> <a href="src/index.ts#L40">src/index.ts#L40</a> <ul><p><span>Partial</span>&lt;<span>InlineConfig</span>&gt;</p> </ul></details></p></ul></details><details id="open$19" title="Function" ><summary><span><a href="#open$19">#</a></span> <code><strong>open</strong></code><em>(options)</em> &ndash; Open a file in Vite.</summary> <a href="src/index.ts#L98">src/index.ts#L98</a> <ul> <p> <details id="options$21" title="Parameter" ><summary><span><a href="#options$21">#</a></span> <code><strong>options</strong></code> &ndash; Open options</summary> <ul><p><span>Partial</span>&lt;<a href="#Options$1">Options</a>&gt;</p> </ul></details> <p><strong>open</strong><em>(options)</em> &nbsp;=&gt; <ul><span>Promise</span>&lt;<a href="#ViteServer$23">ViteServer</a>&gt;</ul></p></p> </ul></details></p>
<p> <details id="ViteServer$25" title="Interface" ><summary><span><a href="#ViteServer$25">#</a></span> <code><strong>ViteServer</strong></code> &ndash; ViteServer return object.</summary> <a href="src/server.ts#L10">src/server.ts#L10</a> <ul> <p> <details id="localAddr$26" title="Property" ><summary><span><a href="#localAddr$26">#</a></span> <code><strong>localAddr</strong></code> &ndash; The local address</summary> <a href="src/server.ts#L12">src/server.ts#L12</a> <ul><p>string</p> </ul></details><details id="networkAddr$27" title="Property" ><summary><span><a href="#networkAddr$27">#</a></span> <code><strong>networkAddr</strong></code> &ndash; The network address</summary> <a href="src/server.ts#L14">src/server.ts#L14</a> <ul><p>string</p> </ul></details><details id="vite$28" title="Property" ><summary><span><a href="#vite$28">#</a></span> <code><strong>vite</strong></code> &ndash; The Vite dev server instance</summary> <a href="src/server.ts#L16">src/server.ts#L16</a> <ul><p><span>ViteDevServer</span></p> </ul></details><details id="log$29" title="Method" ><summary><span><a href="#log$29">#</a></span> <code><strong>log</strong></code><em>(args)</em> &ndash; Log function</summary> <a href="src/server.ts#L18">src/server.ts#L18</a> <ul> <p> <details id="args$31" title="Parameter" ><summary><span><a href="#args$31">#</a></span> <code><strong>args</strong></code> </summary> <ul><p>unknown []</p> </ul></details> <p><strong>log</strong><em>(args)</em> &nbsp;=&gt; <ul>void</ul></p></p> </ul></details></p></ul></details><details id="Options$1" title="Class" ><summary><span><a href="#Options$1">#</a></span> <code><strong>Options</strong></code> </summary> <a href="src/index.ts#L17">src/index.ts#L17</a> <ul> <p> <details id="constructor$2" title="Constructor" ><summary><span><a href="#constructor$2">#</a></span> <code><strong>constructor</strong></code><em>()</em> </summary> <ul> <p> <details id="new Options$3" title="ConstructorSignature" ><summary><span><a href="#new Options$3">#</a></span> <code><strong>new Options</strong></code><em>()</em> </summary> <ul><p><a href="#Options$1">Options</a></p> </ul></details></p> </ul></details><details id="debugging$13" title="Property" ><summary><span><a href="#debugging$13">#</a></span> <code><strong>debugging</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>''</code></span> </summary> <a href="src/index.ts#L36">src/index.ts#L36</a> <ul><p>string</p> </ul></details><details id="debuggingThis$14" title="Property" ><summary><span><a href="#debuggingThis$14">#</a></span> <code><strong>debuggingThis</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>false</code></span> </summary> <a href="src/index.ts#L39">src/index.ts#L39</a> <ul><p>boolean</p> </ul></details><details id="file$8" title="Property" ><summary><span><a href="#file$8">#</a></span> <code><strong>file</strong></code> </summary> <a href="src/index.ts#L21">src/index.ts#L21</a> <ul><p>string</p> </ul></details><details id="https$10" title="Property" ><summary><span><a href="#https$10">#</a></span> <code><strong>https</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>false</code></span> </summary> <a href="src/index.ts#L27">src/index.ts#L27</a> <ul><p>boolean</p> </ul></details><details id="jsx$11" title="Property" ><summary><span><a href="#jsx$11">#</a></span> <code><strong>jsx</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>'react'</code></span> </summary> <a href="src/index.ts#L30">src/index.ts#L30</a> <ul><p>string</p> </ul></details><details id="log$4" title="Property" ><summary><span><a href="#log$4">#</a></span> <code><strong>log</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>defaultLog</code></span> </summary> <a href="src/index.ts#L18">src/index.ts#L18</a> <ul><p><details id="__type$5" title="Function" ><summary><span><a href="#__type$5">#</a></span> <em>(args)</em> </summary> <ul> <p> <details id="args$7" title="Parameter" ><summary><span><a href="#args$7">#</a></span> <code><strong>args</strong></code> </summary> <ul><p>unknown []</p> </ul></details> <p><strong></strong><em>(args)</em> &nbsp;=&gt; <ul>void</ul></p></p> </ul></details></p> </ul></details><details id="noOpen$12" title="Property" ><summary><span><a href="#noOpen$12">#</a></span> <code><strong>noOpen</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>false</code></span> </summary> <a href="src/index.ts#L33">src/index.ts#L33</a> <ul><p>boolean</p> </ul></details><details id="quiet$15" title="Property" ><summary><span><a href="#quiet$15">#</a></span> <code><strong>quiet</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>false</code></span> </summary> <a href="src/index.ts#L42">src/index.ts#L42</a> <ul><p>boolean</p> </ul></details><details id="responses$16" title="Property" ><summary><span><a href="#responses$16">#</a></span> <code><strong>responses</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>{}</code></span> </summary> <a href="src/index.ts#L44">src/index.ts#L44</a> <ul><p><span>Record</span>&lt;string, {<p> <details id="content$19" title="Property" ><summary><span><a href="#content$19">#</a></span> <code><strong>content</strong></code> </summary> <a href="src/index.ts#L44">src/index.ts#L44</a> <ul><p>string</p> </ul></details><details id="type$18" title="Property" ><summary><span><a href="#type$18">#</a></span> <code><strong>type</strong></code> </summary> <a href="src/index.ts#L44">src/index.ts#L44</a> <ul><p>string</p> </ul></details></p>}&gt;</p> </ul></details><details id="root$9" title="Property" ><summary><span><a href="#root$9">#</a></span> <code><strong>root</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>'.'</code></span> </summary> <a href="src/index.ts#L24">src/index.ts#L24</a> <ul><p>string</p> </ul></details><details id="viteOptions$20" title="Property" ><summary><span><a href="#viteOptions$20">#</a></span> <code><strong>viteOptions</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>{}</code></span> </summary> <a href="src/index.ts#L46">src/index.ts#L46</a> <ul><p><span>Partial</span>&lt;<span>InlineConfig</span>&gt;</p> </ul></details></p></ul></details><details id="open$21" title="Function" ><summary><span><a href="#open$21">#</a></span> <code><strong>open</strong></code><em>(options)</em> &ndash; Open a file in Vite.</summary> <a href="src/index.ts#L106">src/index.ts#L106</a> <ul> <p> <details id="options$23" title="Parameter" ><summary><span><a href="#options$23">#</a></span> <code><strong>options</strong></code> &ndash; Open options</summary> <ul><p><span>Partial</span>&lt;<a href="#Options$1">Options</a>&gt;</p> </ul></details> <p><strong>open</strong><em>(options)</em> &nbsp;=&gt; <ul><span>Promise</span>&lt;<a href="#ViteServer$25">ViteServer</a>&gt;</ul></p></p> </ul></details></p>

## Credits

Expand Down
Binary file modified cli.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"author": "stagas",
"short": "stagas/vite-open",
"description": "Open any file directly in a Vite dev server.",
"version": "2.1.1",
"version": "2.2.0",
"license": "MIT",
"repository": {
"type": "git",
Expand Down

0 comments on commit 18f755c

Please sign in to comment.