Skip to content

Commit

Permalink
version 3.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
stagas committed Aug 2, 2022
1 parent ec9f58b commit e81f810
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 4 deletions.
4 changes: 1 addition & 3 deletions README.md
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-v3.0.1-F00.svg?colorA=000"/></a> <a href="src"><img src="https://img.shields.io/badge/loc-382-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-v3.0.2-F00.svg?colorA=000"/></a> <a href="src"><img src="https://img.shields.io/badge/loc-387-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,8 +35,6 @@ Open any file directly in a Vite dev server.

## API

<p> <details id="Options$2" title="Class" ><summary><span><a href="#Options$2">#</a></span> <code><strong>Options</strong></code> </summary> <a href="src/index.ts#L26">src/index.ts#L26</a> <ul> <p> <details id="constructor$3" title="Constructor" ><summary><span><a href="#constructor$3">#</a></span> <code><strong>constructor</strong></code><em>()</em> </summary> <ul> <p> <details id="new Options$4" title="ConstructorSignature" ><summary><span><a href="#new Options$4">#</a></span> <code><strong>new Options</strong></code><em>()</em> </summary> <ul><p><a href="#Options$2">Options</a></p> </ul></details></p> </ul></details><details id="debugging$11" title="Property" ><summary><span><a href="#debugging$11">#</a></span> <code><strong>debugging</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>''</code></span> </summary> <a href="src/index.ts#L33">src/index.ts#L33</a> <ul><p>string</p> </ul></details><details id="debuggingThis$12" title="Property" ><summary><span><a href="#debuggingThis$12">#</a></span> <code><strong>debuggingThis</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>false</code></span> </summary> <a href="src/index.ts#L34">src/index.ts#L34</a> <ul><p>boolean</p> </ul></details><details id="file$5" title="Property" ><summary><span><a href="#file$5">#</a></span> <code><strong>file</strong></code> </summary> <a href="src/index.ts#L27">src/index.ts#L27</a> <ul><p>string</p> </ul></details><details id="https$7" title="Property" ><summary><span><a href="#https$7">#</a></span> <code><strong>https</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>false</code></span> </summary> <a href="src/index.ts#L29">src/index.ts#L29</a> <ul><p>boolean</p> </ul></details><details id="jsx$8" title="Property" ><summary><span><a href="#jsx$8">#</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$14" title="Property" ><summary><span><a href="#log$14">#</a></span> <code><strong>log</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>defaultLog</code></span> </summary> <a href="src/index.ts#L37">src/index.ts#L37</a> <ul><p><details id="__type$15" title="Function" ><summary><span><a href="#__type$15">#</a></span> <em>(args)</em> </summary> <ul> <p> <details id="args$17" title="Parameter" ><summary><span><a href="#args$17">#</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="noForce$10" title="Property" ><summary><span><a href="#noForce$10">#</a></span> <code><strong>noForce</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>false</code></span> </summary> <a href="src/index.ts#L32">src/index.ts#L32</a> <ul><p>boolean</p> </ul></details><details id="noOpen$9" title="Property" ><summary><span><a href="#noOpen$9">#</a></span> <code><strong>noOpen</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>false</code></span> </summary> <a href="src/index.ts#L31">src/index.ts#L31</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#L35">src/index.ts#L35</a> <ul><p>boolean</p> </ul></details><details id="responses$19" title="Property" ><summary><span><a href="#responses$19">#</a></span> <code><strong>responses</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>{}</code></span> </summary> <a href="src/index.ts#L41">src/index.ts#L41</a> <ul><p><span>Record</span>&lt;string, {<p> <details id="content$22" title="Property" ><summary><span><a href="#content$22">#</a></span> <code><strong>content</strong></code> </summary> <a href="src/index.ts#L43">src/index.ts#L43</a> <ul><p>string</p> </ul></details><details id="type$21" title="Property" ><summary><span><a href="#type$21">#</a></span> <code><strong>type</strong></code> </summary> <a href="src/index.ts#L42">src/index.ts#L42</a> <ul><p>string</p> </ul></details><details id="fn$23" title="Method" ><summary><span><a href="#fn$23">#</a></span> <code><strong>fn</strong></code><em>(server, req, res, next)</em> </summary> <a href="src/index.ts#L44">src/index.ts#L44</a> <ul> <p> <details id="server$25" title="Parameter" ><summary><span><a href="#server$25">#</a></span> <code><strong>server</strong></code> </summary> <ul><p><span>ViteDevServer</span></p> </ul></details><details id="req$26" title="Parameter" ><summary><span><a href="#req$26">#</a></span> <code><strong>req</strong></code> </summary> <ul><p><span>IncomingMessage</span></p> </ul></details><details id="res$27" title="Parameter" ><summary><span><a href="#res$27">#</a></span> <code><strong>res</strong></code> </summary> <ul><p><span>ServerResponse</span></p> </ul></details><details id="next$28" title="Parameter" ><summary><span><a href="#next$28">#</a></span> <code><strong>next</strong></code> </summary> <ul><p><span>NextFunction</span></p> </ul></details> <p><strong>fn</strong><em>(server, req, res, next)</em> &nbsp;=&gt; <ul>void</ul></p></p> </ul></details></p>}&gt;</p> </ul></details><details id="root$6" title="Property" ><summary><span><a href="#root$6">#</a></span> <code><strong>root</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>'.'</code></span> </summary> <a href="src/index.ts#L28">src/index.ts#L28</a> <ul><p>string</p> </ul></details><details id="virtual$18" title="Property" ><summary><span><a href="#virtual$18">#</a></span> <code><strong>virtual</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>{}</code></span> </summary> <a href="src/index.ts#L39">src/index.ts#L39</a> <ul><p><span>Record</span>&lt;string, any&gt;</p> </ul></details><details id="viteOptions$29" title="Property" ><summary><span><a href="#viteOptions$29">#</a></span> <code><strong>viteOptions</strong></code> <span><span>&nbsp;=&nbsp;</span> <code>{}</code></span> </summary> <a href="src/index.ts#L52">src/index.ts#L52</a> <ul><p><span>Partial</span>&lt;<span>InlineConfig</span>&gt;</p> </ul></details></p></ul></details><details id="ViteServer$33" title="Interface" ><summary><span><a href="#ViteServer$33">#</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$34" title="Property" ><summary><span><a href="#localAddr$34">#</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$35" title="Property" ><summary><span><a href="#networkAddr$35">#</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$36" title="Property" ><summary><span><a href="#vite$36">#</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$37" title="Method" ><summary><span><a href="#log$37">#</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$39" title="Parameter" ><summary><span><a href="#args$39">#</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="virtualPlugin$1" title="Variable" ><summary><span><a href="#virtualPlugin$1">#</a></span> <code><strong>virtualPlugin</strong></code> </summary> <a href="src/index.ts#L22">src/index.ts#L22</a> <ul><p>any</p> </ul></details><details id="open$30" title="Function" ><summary><span><a href="#open$30">#</a></span> <code><strong>open</strong></code><em>(options)</em> &ndash; Open a file in Vite.</summary> <a href="src/index.ts#L113">src/index.ts#L113</a> <ul> <p> <details id="options$32" title="Parameter" ><summary><span><a href="#options$32">#</a></span> <code><strong>options</strong></code> &ndash; Open options</summary> <ul><p><span>Partial</span>&lt;<a href="#Options$2">Options</a>&gt;</p> </ul></details> <p><strong>open</strong><em>(options)</em> &nbsp;=&gt; <ul><span>Promise</span>&lt;<a href="#ViteServer$33">ViteServer</a>&gt;</ul></p></p> </ul></details></p>

## Credits

- [@babel/core](https://npmjs.org/package/@babel/core) by [The Babel Team](https://babel.dev/team) &ndash; Babel compiler core.
Expand Down
2 changes: 1 addition & 1 deletion package.json
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": "3.0.1",
"version": "3.0.2",
"license": "MIT",
"repository": {
"type": "git",
Expand Down

0 comments on commit e81f810

Please sign in to comment.