tigerbeetle-node 0.14.174 → 0.14.176

package/README.md

@@ -2,13 +2,12 @@
 title: Node.js
 ---
 
-This file is generated by
-[/src/clients/docs_generate.zig](/src/clients/docs_generate.zig).
+<!-- This file is generated by [/src/scripts/client_readmes.zig](/src/scripts/client_readmes.zig). -->
 # tigerbeetle-node
 
 The TigerBeetle client for Node.js.
 
-### Prerequisites
+## Prerequisites
 
 Linux >= 5.6 is the only production environment we
 support. But for ease of development we also support macOS and Windows.
@@ -28,6 +27,7 @@ Now, create `main.js` and copy this into it:
 
 ```javascript
 const { createClient } = require("tigerbeetle-node");
+
 console.log("Import ok!");
 ```
 
@@ -79,7 +79,7 @@ environment variable and defaults to port `3000`.
 ```javascript
 const client = createClient({
   cluster_id: 0n,
-  replica_addresses: [process.env.TB_ADDRESS || '3000']
+  replica_addresses: [process.env.TB_ADDRESS || "3000"],
 });
 ```
 
@@ -162,7 +162,8 @@ let account1 = {
   timestamp: 0n,
   flags: 0,
 };
-account0.flags = AccountFlags.linked | AccountFlags.debits_must_not_exceed_credits;
+account0.flags = AccountFlags.linked |
+  AccountFlags.debits_must_not_exceed_credits;
 accountErrors = await client.createAccounts([account0, account1]);
 ```
 
@@ -229,9 +230,13 @@ for (const error of accountErrors) {
   switch (error.result) {
     case CreateAccountError.exists:
       console.error(`Batch account at ${error.index} already exists.`);
-	  break;
+      break;
     default:
-      console.error(`Batch account at ${error.index} failed to create: ${CreateAccountError[error.result]}.`);
+      console.error(
+        `Batch account at ${error.index} failed to create: ${
+          CreateAccountError[error.result]
+        }.`,
+      );
   }
 }
 ```
@@ -282,7 +287,7 @@ See details for transfer fields in the [Transfers
 reference](https://docs.tigerbeetle.com/reference/transfers).
 
 ```javascript
-let transfer = {
+let transfers = [{
   id: 1n,
   debit_account_id: 102n,
   credit_account_id: 103n,
@@ -296,8 +301,8 @@ let transfer = {
   code: 720,
   flags: 0,
   timestamp: 0n,
-};
-let transferErrors = await client.createTransfers([transfer]);
+}];
+let transferErrors = await client.createTransfers(transfers);
 ```
 
 ### Response and Errors
@@ -316,9 +321,13 @@ for (const error of transferErrors) {
   switch (error.result) {
     case CreateTransferError.exists:
       console.error(`Batch transfer at ${error.index} already exists.`);
-	  break;
+      break;
     default:
-      console.error(`Batch transfer at ${error.index} failed to create: ${CreateTransferError[error.result]}.`);
+      console.error(
+        `Batch transfer at ${error.index} failed to create: ${
+          CreateTransferError[error.result]
+        }.`,
+      );
   }
 }
 ```
@@ -351,7 +360,9 @@ is 8190.
 ```javascript
 const BATCH_SIZE = 8190;
 for (let i = 0; i < transfers.length; i += BATCH_SIZE) {
-  const transferErrors = await client.createTransfers(transfers.slice(i, Math.min(transfers.length, BATCH_SIZE)));
+  const transferErrors = await client.createTransfers(
+    transfers.slice(i, Math.min(transfers.length, BATCH_SIZE)),
+  );
   // error handling omitted
 }
 ```
@@ -528,7 +539,7 @@ the same as the order of `id`s in the request. You can refer to the
 `id` field in the response to distinguish transfers.
 
 ```javascript
-const transfers = await client.lookupTransfers([1n, 2n]);
+transfers = await client.lookupTransfers([1n, 2n]);
 console.log(transfers);
 /*
  * [{
@@ -568,8 +579,8 @@ let filter = {
   flags: GetAccountTransfersFlags.debits | // Include transfer from the debit side.
     GetAccountTransfersFlags.credits | // Include transfer from the credit side.
     GetAccountTransfersFlags.reversed, // Sort by timestamp in reverse-chronological order.
-}
-const account_transfers = await client.getAccountTransfers(filter)
+};
+const account_transfers = await client.getAccountTransfers(filter);
 ```
 
 ## Linked Events
@@ -602,7 +613,7 @@ batch.push({ id: 1n /* , ... */ });
 batch.push({ id: 2n, /* ..., */ flags: linkedFlag }); // Commit/rollback.
 batch.push({ id: 3n, /* ..., */ flags: linkedFlag }); // Commit/rollback.
 batch.push({ id: 2n, /* ..., */ flags: linkedFlag }); // Fail with exists
-batch.push({ id: 4n, /* ..., */ flags: 0 });          // Fail without committing.
+batch.push({ id: 4n, /* ..., */ flags: 0 }); // Fail without committing.
 
 // An individual transfer (successful):
 // This should not see any effect from the failed chain above.
@@ -631,33 +642,3 @@ const errors = await client.createTransfers(batch);
  * ]
  */
 ```
-
-## Development Setup
-
-### On Linux and macOS
-
-In a POSIX shell run:
-
-```console
-git clone https://github.com/tigerbeetle/tigerbeetle
-cd tigerbeetle
-git submodule update --init --recursive
-./scripts/install_zig.sh
-cd src/clients/node
-npm install --include dev
-npm pack
-```
-
-### On Windows
-
-In PowerShell run:
-
-```console
-git clone https://github.com/tigerbeetle/tigerbeetle
-cd tigerbeetle
-git submodule update --init --recursive
-.\scripts\install_zig.bat
-cd src/clients/node
-npm install --include dev
-npm pack
-```

package/package.json

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