tigerbeetle-node - npm Package Compare versions

Comparing version 0.12.49 to 0.12.50

package.json

 {
   "name": "tigerbeetle-node",
-  "version": "0.12.49",
+  "version": "0.12.50",
   "description": "TigerBeetle Node.js client",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -0,4 +1,7 @@
+---
+title: Node.js
+---
+
 This file is generated by
 [src/clients/docs_generate.zig](/src/clients/docs_generate.zig).
-
 # tigerbeetle-node
@@ -11,9 +14,5 @@
 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
@@ -53,2 +52,13 @@
 
+## 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`
@@ -285,2 +295,10 @@ TigerBeetle uses 64-bit integers for many fields while JavaScript's
 
+### 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
@@ -469,3 +487,3 @@
 
-Unsupported.
+Not yet supported.
 

No alert changes

Improved metrics

Total package byte prevSize

6778486

increased by0.01%

Number of lines in readme file

486

increased by3.85%

No dependency changes