- Notifications
You must be signed in to change notification settings - Fork51
nwjs/npm-installer
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
An npm installer forNW.js.
Please go through theCHANGELOG carefully and choose the appropriate version. Bug fixes and feature updates are pushed to the repo periodically.
npm install -g nw
You might run into issues installing globally.Learn how to fix this
npm install --save-dev nw
npm install --save-dev nw@0.85.0-1
You may use
npm view nw versions
to view the list of available versions.
npm install --save-dev nw@sdk
Or setnwjs_build_type=sdk
in.npmrc
orNWJS_BUILD_TYPE=sdk
environment variable.
Setnwjs_platform
in.npmrc
orNWJS_PLATFORM
environment variable. Defaults toprocess.platform
.
Setnwjs_arch
in.npmrc
orNWJS_ARCH
environment variable. Defaults toprocess.arch
.
Setnwjs_cache_dir
in.npmrc
orNWJS_ARCH
environment variable. Defaults to./node_modules/nw
.
Setnwjs_cache
in.npmrc
orNWJS_ARCH
environment variable to keep or delete cached binaries. Defaults totrue
.
Setnwjs_ffmpeg
in.npmrc
orNWJS_ARCH
environment variable to toggle downloadingcommunity FFmpeg binaries. Defaults tofalse
.
Setnwjs_native_addon
in.npmrc
orNWJS_NATIVE_ADDON
environment variable to toggle downloading NW.js Node headers. Defaults tofalse
.
Setnwjs_urlbase
in.npmrc
orNWJS_URLBASE
environment variable. Defaults tohttps://dl.nwjs.io
. The file system (file://
) is also supported (for example,file:///home/localghost/local_mirror
).
Setnwjs_unref
in.npmrc
orNWJS_UNREF
environment variable. Default tofalse
. This is useful if you're usingnw
package to call the executable and want to prevent zombie processes eating up memory.
Add a script in yourpackage.json
:
{"scripts": {"start":"nw /path/to/app" }}
Executingnpm start
runs the NW.js app. Omitting the file path makes NW.js check for valid project in current working directory. You can also callnw
directly fromnode_modules/.bin/nw
.
import{findpath}from'nw';letpath=awaitfindpath();
import{findpath}from'nw';letpath=awaitfindpath('chromedriver',{flavor:'sdk'});
import{get}from'nw';awaitget({// options});
Options:
Name | Type | Default | Description |
---|---|---|---|
version | string | "latest" | "stable" | "latest" | Runtime version |
flavor | "normal" | "sdk" | "normal" | Runtime flavor |
platform | "linux" | "osx" | "win" | Host platform | |
arch | "ia32" | "x64" | "arm64" | Host architecture | |
downloadUrl | "https://dl.nwjs.io" | "https://npm.taobao.org/mirrors/nwjs" | https://npmmirror.com/mirrors/nwjs | "https://github.com/corwin-of-amber/nw.js/releases/" | "https://dl.nwjs.io" | Download server |
cacheDir | string | "./cache" | Directory to cache NW binaries |
cache | boolean | true | If true the existing cache is used. Otherwise it removes and redownloads it. |
ffmpeg | boolean | false | If true the chromium ffmpeg is replaced by community version with proprietary codecs. |
nodeAddon | false | "gyp" | false | Download Node headers |
NW.js's code and this installer use the MIT license.
About
npm installer for NW.js