Skip to content

Node-API, ESM, Cleanup #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bradisbell wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Node-API, ESM, Cleanup #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f90fe61
Migrated from NAN to Node-API.
bradisbell Jan 26, 2026
ad673d5
Removed dependency on eventemitter3. These days, the built-in EventE…
bradisbell Jan 26, 2026
5784e48
Removed unneeded dependency on node-gyp.
bradisbell Jan 26, 2026
65b02c2
ESM
bradisbell Jan 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 5 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,21 @@ Emits events about **overruns**, **short reads**, deviating **sample rates** or

## Compatibility

Tested (module compiles and records audio) with the following Node versions:

- `v6.17.1 (lts/boron)`
- `v8.9.4`
- `v8.11.3`
- `v8.17.0 (lts/carbon)`
- `v10.22.1 (lts/dubnium)`
- `v12.14.1`
- `v12.18.4 (lts/erbium)`
- `v14.16.0 (lts/fermium)`
- `v15.11.0`
- `v16.13.0 (lts/gallium)`
- `v17.1.0`
- `v18.11.0` (successfully built, but audio recording not tested)
- `v19.0.0 (current)`
Version `0.4.0` is the first version to use Node-API. It should be compatible with all modern Node.js versions (>=10.x).

Version `0.3.0` was the last version to use NAN. It was tested with Node.js `v6.17.1 (lts/boron)` through `v19.0.0`.

## Dependencies

To build native Node.js modules, this projects uses [node-gyp](https://github.com/nodejs/node-gyp), which requires[[1]](https://github.com/nodejs/node-gyp#on-unix):

- Python v3.6, v3.7, v3.8, or v3.9
- make
- A proper C/C++ compiler toolchain, like GCC (must support 'c++17')
)
- A proper C/C++ compiler toolchain, like GCC

This module also requires a `libasound2-dev` for `<alsa/asoundlib.h>` and `libasound2` to link against `libasound.so.2`.

On debian derivatives system you can install all dependencies with `apt`:
On Debian derivatives system you can install all dependencies with `apt`:

```bash
sudo apt install libasound2 libasound2-dev
Expand Down
23 changes: 11 additions & 12 deletions binding.gyp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
{
"targets": [
{
"target_name": "capture",
"sources": ["capture.cc"],
"libraries": ["-lasound -lm"],
"cflags": ["-Wall", "-std=c++17"],
"cflags_cc": ["-Wall", "-std=c++17"],
"cflags!": ["-fno-exceptions"],
"cflags_cc!": ["-fno-exceptions"],
"include_dirs": ["<!(node -e \"require('nan')\")"],
}
]
"targets": [
{
"target_name": "capture",
"sources": [ "capture.cc" ],
"libraries": [ "-lasound", "-lm" ],
"cflags_cc": [ "-std=c++11" ],
"cflags!": [ "-fno-exceptions" ],
"cflags_cc!": [ "-fno-exceptions" ],
"defines": [ "NAPI_VERSION=8" ]
}
]
}
Loading