vite-open

open a file in a vite dev server

Usage no npm install needed!

<script type="module">
  import viteOpen from 'https://cdn.skypack.dev/vite-open';
</script>

README

vite-open

open a file in a vite dev server

🔧 Install · 🧩 Example · 📜 API docs · 🔥 Releases · 💪🏼 Contribute · 🖐️ Help


Install

npm i -g vite-open

Example

vite-open my-file.ts

Usage

Usage: vite-open [options] <file>

                 <file>  File to open (can be a .js or .ts file)

   --root=...            Root directory to serve files from
   --https               Use https
   --quiet               Quiet output

API

Table of Contents

open

src/index.ts:79-139

Open a file in Vite.

Parameters

  • options Partial<Options> Open options

    • options.log Log function
    • options.file File to open (can be a .js or .ts file)
    • options.root Root directory to serve files from
    • options.https Use https
    • options.quiet Quiet output

Returns Promise<ViteServer> ViteDevServer

ViteServer

src/server.ts:10-17

ViteServer return object.

localAddr

src/server.ts:12-12

The local address

Type: string

networkAddr

src/server.ts:14-14

The network address

Type: string

vite

src/server.ts:16-16

The Vite dev server instance

Type: ViteDevServer

createViteServer

src/server.ts:25-51

Creates a vite dev server instance.

Parameters

  • viteConfig ViteConfig Vite configuration. (optional, default {})

Returns Promise<ViteServer> ViteServer

Contribute

Fork or edit and submit a PR.

All contributions are welcome!

License

MIT © 2022 stagas