tigerbeetle-node 0.12.48 → 0.12.50

package/README.md

@@ -1,6 +1,9 @@
+---
+title: Node.js
+---
+
 This file is generated by
 [src/clients/docs_generate.zig](/src/clients/docs_generate.zig).
-
 # tigerbeetle-node
 
 The TigerBeetle client for Node.js.
@@ -8,13 +11,9 @@ The TigerBeetle client for Node.js.
 ### Prerequisites
 
 Linux >= 5.6 is the only production environment we
-support. But for ease of development we support macOS and
-Windows unless otherwise noted.
-
+support. But for ease of development we also support macOS.
 * NodeJS >= `14`
 
-> Windows support is not yet available for the Node client.
-
 ## Setup
 
 Run:
@@ -49,6 +48,17 @@ steps that are run in CI to test support:
 * [Ubuntu](https://github.com/tigerbeetledb/tigerbeetle/blob/main/src/clients/node/scripts/scripts/test_install_on_ubuntu.sh)
 * [RHEL](https://github.com/tigerbeetledb/tigerbeetle/blob/main/src/clients/node/scripts/scripts/test_install_on_rhelubi.sh)
 
+## Example projects
+
+This document is primarily a reference guide to
+the client. Below are various sample projects demonstrating
+features of TigerBeetle.
+
+* [Basic](/src/clients/node/samples/basic/): Create two accounts and
+  transfer an amount between them.
+* [Two-Phase Transfer](/src/clients/node/samples/two-phase/): Create two
+  accounts and start a pending transfer between them, then
+  post the transfer.
 ### Sidenote: `BigInt`
 TigerBeetle uses 64-bit integers for many fields while JavaScript's
 builtin `Number` maximum value is `2^53-1`. The `n` suffix in JavaScript
@@ -280,6 +290,14 @@ for (let i = 0; i < transfers.length; i += BATCH_SIZE) {
 }
 ```
 
+### Queues and Workers
+
+If you are making requests to TigerBeetle from workers
+pulling jobs from a queue, you can batch requests to
+TigerBeetle by having the worker act on multiple jobs from
+the queue at once rather than one at a time. i.e. pulling
+multiple jobs from the queue rather than just one.
+
 ## Transfer Flags
 
 The transfer `flags` value is a bitfield. See details for these flags in
@@ -463,5 +481,5 @@ $ [ "$TEST" = "true" ] && mvn test || echo "Skipping client unit tests"
 
 ### On Windows
 
-Unsupported.
+Not yet supported.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tigerbeetle-node",
-  "version": "0.12.48",
+  "version": "0.12.50",
   "description": "TigerBeetle Node.js client",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",