@aspiesolutions/lib-neon-graphql v0.0.2

lib-neon

This project was bootstrapped by create-neon.

Installing lib-neon

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

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

$ yarn install

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

Building lib-neon

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

$ yarn run build

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

Exploring lib-neon

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

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

Available Scripts

In the project directory, you can run:

yarn install

Installs the project, including running yarn run build.

yarn build

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

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

yarn run build -- --feature=beetle

yarn build-debug

Alias for yarn build.

yarn build-release

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

npm test

Runs the unit tests by calling cargo test. You can learn more about adding tests to your Rust code from the Rust book.

Project Layout

The directory structure of this project is:

lib-neon/
├── Cargo.toml
├── README.md
├── index.node
├── package.json
├── src/
|   └── lib.rs
└── target/

Cargo.toml

The Cargo manifest file, which informs the cargo command.

README.md

This file.

index.node

The Node addon—i.e., a binary Node module—generated by building the project. This is the main module for this package, as dictated by the "main" key in package.json.

Under the hood, a Node addon is a dynamically-linked shared object. The "build" script produces this file by copying it from within the target/ directory, which is where the Rust build produces the shared object.

package.json

The npm manifest file, which informs the npm command.

src/

The directory tree containing the Rust source code for the project.

src/lib.rs

The Rust library's main module.

target/

Binary artifacts generated by the Rust build.

Learn More

To learn more about Neon, see the Neon documentation.

To learn more about Rust, see the Rust documentation.

To learn more about Node, see the Node documentation.