Skip to content

beeping-io/beeping-node

🟒 Beeping Node

License status platform conventional commits Node TypeScript pnpm

πŸ”Š Official Node.js SDK for data over sound (audible + ultrasonic). Encode / decode payloads locally via N-API binding to beeping-core (C++20) or remotely via the Beeping Platform cloud (beepbox-server). One package, dual mode. Part of the Beeping Platform ecosystem.


πŸ“₯ Install

Once the package is published to npm (BEE-132):

pnpm add @beeping/node
# or: npm i @beeping/node
# or: yarn add @beeping/node

Until then, consume directly from the repo:

pnpm add github:beeping-io/beeping-node#develop

πŸš€ Quick start

import { createClient } from '@beeping/node';

const client = createClient({ mode: 'auto' });

const audio = await client.encode(Buffer.from('hello'));
const payload = await client.decode(audio);

πŸ—οΈ Build

pnpm install
pnpm build

πŸ§ͺ Test

pnpm test
pnpm test:coverage

πŸ”Ž Lint

pnpm lint
pnpm format:check

πŸ“š Docs

πŸ“œ License

Apache-2.0 Β© 2026 Beeping

About

🟒 Official Node.js SDK for data over sound (audible + ultrasonic) β€” dual-mode local/cloud. Part of the Beeping Platform.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors