NGW Types Loader

A CLI tool that downloads TypeScript declarations from a NextGIS Web deployment and installs them as resolvable packages. Use it when consuming the typed NgwConnector.route() API or other declarations that import @nextgisweb/* modules.

Installation

npm install --save-dev @nextgis/ngw-types-loader
Copy

Usage

Run the loader without installing it:

npx @nextgis/ngw-types-loader
Copy

For a custom NextGIS Web deployment:

npx @nextgis/ngw-types-loader https://your-ngw-server.com
Copy

If the loader is installed in the project, you can use its executable directly. By default, the loader downloads declarations from https://demo.nextgis.com:

ngw-types-loader
Copy

For a custom NextGIS Web deployment, pass its URL:

ngw-types-loader https://your-ngw-server.com
Copy

The declarations are installed under node_modules/@nextgisweb. Imports such as @nextgisweb/resource/type/api are resolved by TypeScript without adding a generated file to tsconfig.json.

Run the loader from postinstall when the declarations should be regenerated after installing dependencies:

{
  "scripts": {
    "postinstall": "ngw-types-loader"
  }
}
Copy

Package managers and deployment environments may skip lifecycle scripts. Keep the explicit npx @nextgis/ngw-types-loader ... command in project setup and CI documentation even when postinstall is configured.

Use the URL of your own server when its installed components or version differ from NextGIS Cloud.

Run the loader again after changing the NextGIS Web version, installed components or extensions, or after recreating node_modules.

API documentation

See the NextGIS Web API documentation.

See also the package architecture guide.

Commercial support

Need help with @nextgis/ngw-types-loader? Contact NextGIS.