@speedapi/node
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

License Version Coverage Downloads Size PRs and issues

SpeedAPI Node.JS transport

This library provides a SpeedAPI transport level implementation for the Node.JS runtime. Install it with:

npm i @speedapi/node

And check out the main package for its installation instructions.

What is SpeedAPI?

It's a platform-agnostic API and serialization tool specifically geared towards high-throughput realtime applications. You can read more about its features here

How do I use it?

There's a complete tutorial over here.

What are the exported classes?

*Client, *Server and *Listener, where * is each of Tcp, Tls and Ws (WebSocket)

  • Clients are supposed to be instantiated on the client side;
  • Listeners are supposed to be instantiated on the server side;
  • Servers are instantiated by Listeners for each connection and passed to you via a callback.

Testing

Warning: this repository uses a pnpm lock file, hence you can't substitute it for npm below.

git clone https://github.com/speedapi/driver-ts
cd driver-ts
pnpm i
pip3 install susc
pnpm test

Package Sidebar

Install

npm i @speedapi/node

Weekly Downloads

0

Version

1.0.1

License

BSD-3-Clause

Unpacked Size

17.4 kB

Total Files

8

Last publish

Collaborators

  • portasynthinca3