An installer for NW.js
npm install nwAn npm installer for NW.js.
Please go through the CHANGELOG carefully and choose the appropriate version. Bug fixes and feature updates are pushed to the repo periodically.
``shell`
npm install -g nw
You might run into issues installing globally. Learn how to fix this
`shell`
npm install --save-dev nw
`shell`
npm install --save-dev nw@0.94.1-1
> You may use npm view nw versions to view the list of available versions.
For more options, see the Options table below.
Add a script in your package.json:
`json`
{
"scripts": {
"start": "nw /path/to/app"
}
}
Executing npm start runs the NW.js app. Omitting the file path makes NW.js check for valid project in current working directory. You can also call nw directly from ./node_modules/.bin/nw.
` js`
import { findpath } from 'nw';
let path = await findpath();
` js`
import { findpath } from 'nw';
let path = await findpath('chromedriver', { flavor: 'sdk' });
`js
import { get } from 'nw';
await get({
version: '0.14.7'
// other options
});
`
| Name | Type | Default | Description | CLI Usage | .npmrc Usage | .env Usage | Module Usage |
| ---- | ------- | --------- | ----------- | --------- | ------------ | ---------- | ------------ |
| version | string \| "latest" \| "stable" | "latest" | Runtime version | npm install --save-dev nw | | | get({ version: "latest" }) |"normal" \| "sdk"
| flavor | | "normal" | Runtime flavor | npm install --save-dev nw@sdk | nwjs_build_type=sdk | export NWJS_BUILD_TYPE=sdk | get({ flavor: "sdk" }) |"linux" \| "osx" \| "win"
| platform | | | Host platform | npm install --save-dev --nwjs-platform nw | nwjs_platform=linux | NWJS_PLATFORM=linux | get({ platform: "linux" }) |"ia32" \| "x64" \| "arm64"
| arch | | | Host architecture | npm install --save-dev --nwjs-arch nw | nwjs_arch=x64 | NWJS_ARCH=x64 | get({ arch: "x64"}) |"https://dl.nwjs.io" \| "https://npm.taobao.org/mirrors/nwjs" \| https://npmmirror.com/mirrors/nwjs \| "https://github.com/corwin-of-amber/nw.js/releases/ nw"
| downloadUrl | | "https://dl.nwjs.io" | Download server (https and file system is supported, for eg file:///home/user/nwjs_cache) | npm install --save-dev --nwjs-urlbase=https://dl.nwjs.io | nwjs_urlbase=https://dl.nwjs.io | NWJS_URLBASE=https://dl.nwjs.io | get({ downloadUrl: "https://dl.nwjs.io"}) |string
| cacheDir | | ./node_modules/nw | Directory to cache NW binaries | npm install --save-dev --nwjs-cache-dir ./cache nw | nwjs_cache_dir=./cache | NWJS_CACHE_DIR=./cache | get({ cacheDir: "./cache" }) |string
| sirDir | | . | File path to NW.js project | nw . | | | get({ srcDir: "." }) |boolean
| cache | | true| If true the existing cache is used. Otherwise it removes and redownloads it. | npm install --save-dev --nwjs-cache=true nw | nwjs_cache=true | NWJS_CACHE=true | get({ cache: true }) |boolean
| ffmpeg | | false| If true the chromium ffmpeg is replaced by community version with proprietary codecs. | npm install --save-dev --nwjs-ffmpeg=true nw | nwjs_ffmpeg=true | NWJS_FFMPEG=true | get({ ffmpeg: true }) |false \| "gyp"
| nodeAddon | | false | Download Node headers | npm install --save-dev --nwjs-native-addon=true nw | nwjs_native_addon=true | NWJS_NATIVE_ADDON=true | get({ nativeAddon: true }) |boolean
| unref | | false | Prevent the parent process from waiting for a given subprocess. This is useful if you're using nw package to call the executable and want to prevent zombie processes eating up memory. | npm install --save-dev --nwjs-unref=true nw | nwjs_unref=true | NWJS_UNREF=true | get({ unref: true }) |boolean
shaSum | | true | If true, then shasums are verified. Otherwise, it is ignored. | npm install --save-dev --nwjs-shasum=true nw | nwjs_shasum=true | NWJS_SHASUM=true | get({ shaSum: true })` |
> Note: While using the CLI interface, /path/to/project refers to options.srcDir in the JavaScript API or JSON object.
NW.js's code and this installer use the MIT license.