tigerbeetle-node
Advanced tools
Comparing version 0.14.174 to 0.14.175
{ | ||
"name": "tigerbeetle-node", | ||
"version": "0.14.174", | ||
"version": "0.14.175", | ||
"description": "TigerBeetle Node.js client", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
@@ -5,4 +5,3 @@ --- | ||
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 | ||
@@ -12,3 +11,3 @@ | ||
### Prerequisites | ||
## Prerequisites | ||
@@ -33,2 +32,3 @@ Linux >= 5.6 is the only production environment we | ||
const { createClient } = require("tigerbeetle-node"); | ||
console.log("Import ok!"); | ||
@@ -85,3 +85,3 @@ ``` | ||
cluster_id: 0n, | ||
replica_addresses: [process.env.TB_ADDRESS || '3000'] | ||
replica_addresses: [process.env.TB_ADDRESS || "3000"], | ||
}); | ||
@@ -169,3 +169,4 @@ ``` | ||
}; | ||
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]); | ||
@@ -237,5 +238,9 @@ ``` | ||
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] | ||
}.`, | ||
); | ||
} | ||
@@ -291,3 +296,3 @@ } | ||
```javascript | ||
let transfer = { | ||
let transfers = [{ | ||
id: 1n, | ||
@@ -306,4 +311,4 @@ debit_account_id: 102n, | ||
timestamp: 0n, | ||
}; | ||
let transferErrors = await client.createTransfers([transfer]); | ||
}]; | ||
let transferErrors = await client.createTransfers(transfers); | ||
``` | ||
@@ -327,5 +332,9 @@ | ||
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] | ||
}.`, | ||
); | ||
} | ||
@@ -363,3 +372,5 @@ } | ||
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 | ||
@@ -541,3 +552,3 @@ } | ||
```javascript | ||
const transfers = await client.lookupTransfers([1n, 2n]); | ||
transfers = await client.lookupTransfers([1n, 2n]); | ||
console.log(transfers); | ||
@@ -582,4 +593,4 @@ /* | ||
GetAccountTransfersFlags.reversed, // Sort by timestamp in reverse-chronological order. | ||
} | ||
const account_transfers = await client.getAccountTransfers(filter) | ||
}; | ||
const account_transfers = await client.getAccountTransfers(filter); | ||
``` | ||
@@ -617,3 +628,3 @@ | ||
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. | ||
@@ -647,31 +658,1 @@ // An individual transfer (successful): | ||
``` | ||
## 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 | ||
``` |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
15465558
645