webview

1.1.0 • Public • Published

webview

This package wraps https://github.com/suchipi/webview so it can be distributed on npm and run from node.

Installation

As a global CLI application:

npm i -g webview

As a node module:

npm i --save webview

Usage (CLI)

webview
webview -d ./public --title "My Site"
webview --url http://google.com --width 1024 --height 768
webview --help

Usage (Node)

var webview = require("@suchipi/webview");

// webview is an object with this shape:
// {
//   binaryPath: string, // The absolute path to the binary for your platform
//   optionsToArgv: Function, // Convert an options object to the appropriate argv to pass to the binary
//   spawn: Function, // use child_process.spawn to run the binary
//   spawnSync: Function, // use child_process.spawnSync to run the binary
//   exec: Function, // use child_process.execFile to run the binary
//   execSync: Function, // use child_process.execFileSync to run the binary
// }

// You can either use webview.binaryPath and webview.optionsToArgv to spawn it yourself:
var child = require("child_process").spawn(
  webview.binaryPath,
  optionsToArgv({
    title: "My App",
    width: 1024,
    height: 768,
    dir: "./public",
  }),
  {
    cwd: process.cwd(),
  }
);

// or you can use the provided helper functions to spawn it using child_process.
// Note that the helper function accepts webview options and spawn options in the same object.
var child = webview.spawn({
  // options for webview
  title: "My App",
  width: 1024,
  height: 768,
  dir: "./public",

  // options for child_process.spawn
  cwd: process.cwd(),
});

Readme

Keywords

none

Package Sidebar

Install

Weekly Downloads

133

Version

1.1.0

License

MIT

Unpacked Size

32.4 MB

Total Files

17

Last publish

Collaborators

  • suchipi