@nwutils/getter

Download NW.js and related binaries for Linux, MacOS and Windows.

Getting Started

1. Install Volta
2. npm i to install third party dependencies

Usage

import get from "@nwutils/getter";

await get({
    version: "latest",
    flavor: "normal",
    platform: "linux",
    arch: "x64",
    downloadUrl: "https://dl.nwjs.io",
    manifestUrl: "https://nwjs.io/versions.json",
    cacheDir: "./cache",
    cache: true,
    ffmpeg: false,
    nativeAddon: false,
    shaSum: true,
});

API Reference

Options

| Name | Type | Description | | ---- | ------- | ----------- | | version | string \| "latest" \| "stable" | Runtime version | | flavor | "normal" \| "sdk" | 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/" | Download server. Supports file systems too (for example file:///home/user/nwjs_mirror) | | manifestUrl | "https://nwjs.io/versions.json" \| "https://raw.githubusercontent.com/nwutils/nw-builder/main/src/util/osx.arm.versions.json" | Versions manifest | | cacheDir | string | Directory to cache NW binaries | | cache | boolean | If true the existing cache is used. Otherwise it removes and redownloads it. | | ffmpeg | boolean | If true the chromium ffmpeg is replaced by community version with proprietary codecs. | | nativeAddon | boolean | If true download NW.js Node headers. | | shaSum | boolean | Flag to enable/disable shasum checks. |

Contributing

External contributor

• Use Node.js standard libraries whenever possible.
• Prefer to use syncronous APIs over modern APIs which have been introduced in later versions.

Maintainer

• npm trusted publishing is used for releases
• a package is released when a maintainer creates a release note for a specific version