Home

Awesome

neon-examples

Github Actions

Examples and common patterns for Neon.

All examples are for napi-backend. For examples using legacy-backend see the legacy branch.

Table of Contents

ExampleDescription
async-sqliteAsync interface to a SQLite database
cpu-countReturn the number of CPUs
gzip-streamAsynchronously compress a stream of data
hello-worldReturn a JS String with a greeting message
tokio-fetchAsynchronously fetch a node release date

Contributing

Setup

The examples repository uses the npm 7 workspaces feature.

# npm 7 is required
npm --version

git clone https://github.com/neon-bindings/examples.git
cd examples
npm install

Tests

npm test