JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 12
  • Score
    100M100P100Q55302F
  • License MIT

Tools for running, patching, and packaging NW.js apps.

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (nwts-tools) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    NW.ts-Tools

    A toolkit for running, patching and packaging NW.js apps.

    Usage

    # Add NW.ts-Tools as a dependency.
npm i -D nwts-tools

    You should also have nw installed as a devDependency.

    patch-codecs

    Replaces the FFmpeg library originally included with NW.js. Credits to nwjs-ffmpeg-prebuilt for the prebuilt binaries. Use this patch only for free and open-source projects. Licensing restrictions apply for closed-source software.

    More information: FFmpeg License and Legal Considerations.

    # Run from your project's root directory:
npx nwts-patch-codecs

    package

    This script downloads a fresh copy from nw (the same version as you specified in your package.json minus -sdk) and packages it alongside your already built application. It also bundles the dependencies listed in your package.json(devDependencies not included).

    # Run from your project's root directory:
npx nwts-package

# Or, modified by environment variables:
PACKAGE_TYPE=zip NWJS_FFMPEG=PATCH NWJS_VERSION=0.55.0-sdk npx nwts-package

    Environment variables used by these scripts are enumerated inside types/env.d.ts.

    run

    Used mainly build the app, launch it and attach the debugger in one step.

    npx nwts-run

    Typed Node.js built-in modules

    NW.js imports built-in modules with the require() function. Here is provided a collection of typed exports. Some examples:

    import util from "nwts-tools/node/util";
import fs from "nwts-tools/node/fs";
import child_process, { promises } from "nwts-tools/node/child_process";
import http from "nwts-tools/node/http";
import os from "nwts-tools/node/os";
import path from "nwts-tools/node/path";

    Dependencies

    Windows

    • Powershell

    MacOS and Linux

    • zip, required for nwts-package when PACKAGE_TYPE is set to zip.
    • unzip, required for nwts-patch-codecs and for nwts-package when NWJS_FFMPEG is set to PATCH.

    Check out this Solid.js project starter that takes full advantage of NW.ts-Tools features:

    NW.ts Solid Starter