@distributive/overwatch-config-lib

overwatch-config-lib

This project aids in reading the overwatch config for each microservice i a reliable and consistent way.

This project was bootstrapped by create-neon.

Installing overwatch-config-lib

Installing overwatch-config-lib requires a supported version of Node and Rust.

You can install the project with npm. In the project directory, run:

$ npm install

This fully installs the project, including installing any dependencies and running the build.

Building overwatch-config-lib

If you have already installed the project and only want to run the build, run:

$ npm run build

This command uses the cargo-cp-artifact utility to run the Rust build and copy the built library into ./index.node.

Exploring overwatch-config-lib

After building overwatch-config-lib, you can explore its exports at the Node REPL:

$ npm install
$ node
> require('.').hello()
"hello node"

Available Scripts

In the project directory, you can run:

npm install

Installs the project, including running npm run build.

npm build

Builds the Node addon (index.node) from source.

Additional cargo build arguments may be passed to npm build and npm build-* commands. For example, to enable a cargo feature:

npm run build -- --feature=beetle

npm build-debug

Alias for npm build.

npm build-release

Same as npm build but, builds the module with the release profile. Release builds will compile slower, but run faster.