@bopen-io/wallet-toolbox 2.14.5 → 2.15.0-bopen.1

package/docs/setup.md

@@ -838,6 +838,20 @@ DEV_KEYS = '{
         const knex = makeKnex(config);
         return knex;
     }
+    static createPostgresKnex(connection: string, database?: string): Knex {
+        const c: Knex.PgConnectionConfig = JSON.parse(connection);
+        if (database) {
+            c.database = database;
+        }
+        const config: Knex.Config = {
+            client: "pg",
+            connection: c,
+            pool: { min: 0, max: 7, idleTimeoutMillis: 15000 }
+        };
+        const knex = makeKnex(config);
+        usePostgresInt8Numbers(knex);
+        return knex;
+    }
     static async createWalletMySQL(args: SetupWalletMySQLArgs): Promise<SetupWalletKnex> {
         return await this.createWalletKnex({
             ...args,
@@ -853,7 +867,38 @@ DEV_KEYS = '{
 }
 ```
 
-See also: [Chain](./client.md#type-chain), [KeyPairAddress](./setup.md#interface-keypairaddress), [Monitor](./monitor.md#class-monitor), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [ScriptTemplateUnlock](./client.md#interface-scripttemplateunlock), [Services](./services.md#class-services), [SetupEnv](./setup.md#interface-setupenv), [SetupWallet](./setup.md#interface-setupwallet), [SetupWalletArgs](./setup.md#interface-setupwalletargs), [SetupWalletClient](./setup.md#interface-setupwalletclient), [SetupWalletClientArgs](./setup.md#interface-setupwalletclientargs), [SetupWalletKnex](./setup.md#interface-setupwalletknex), [SetupWalletKnexArgs](./setup.md#interface-setupwalletknexargs), [SetupWalletMySQLArgs](./setup.md#interface-setupwalletmysqlargs), [SetupWalletSQLiteArgs](./setup.md#interface-setupwalletsqliteargs), [StorageClient](./storage.md#class-storageclient), [StorageKnex](./storage.md#class-storageknex), [WERR_INVALID_OPERATION](./client.md#class-werr_invalid_operation), [Wallet](./client.md#class-wallet), [WalletStorageManager](./storage.md#class-walletstoragemanager), [createAction](./storage.md#function-createaction), [fundWalletFromP2PKHOutpoints](./client.md#function-fundwalletfromp2pkhoutpoints), [verifyTruthy](./client.md#function-verifytruthy)
+See also: [Chain](./client.md#type-chain), [KeyPairAddress](./setup.md#interface-keypairaddress), [Monitor](./monitor.md#class-monitor), [PrivilegedKeyManager](./client.md#class-privilegedkeymanager), [ScriptTemplateUnlock](./client.md#interface-scripttemplateunlock), [Services](./services.md#class-services), [SetupEnv](./setup.md#interface-setupenv), [SetupWallet](./setup.md#interface-setupwallet), [SetupWalletArgs](./setup.md#interface-setupwalletargs), [SetupWalletClient](./setup.md#interface-setupwalletclient), [SetupWalletClientArgs](./setup.md#interface-setupwalletclientargs), [SetupWalletKnex](./setup.md#interface-setupwalletknex), [SetupWalletKnexArgs](./setup.md#interface-setupwalletknexargs), [SetupWalletMySQLArgs](./setup.md#interface-setupwalletmysqlargs), [SetupWalletSQLiteArgs](./setup.md#interface-setupwalletsqliteargs), [StorageClient](./storage.md#class-storageclient), [StorageKnex](./storage.md#class-storageknex), [WERR_INVALID_OPERATION](./client.md#class-werr_invalid_operation), [Wallet](./client.md#class-wallet), [WalletStorageManager](./storage.md#class-walletstoragemanager), [createAction](./storage.md#function-createaction), [fundWalletFromP2PKHOutpoints](./client.md#function-fundwalletfromp2pkhoutpoints), [usePostgresInt8Numbers](./storage.md#function-usepostgresint8numbers), [verifyTruthy](./client.md#function-verifytruthy)
+
+###### Method createPostgresKnex
+
+Creates a knex for a Postgres `StorageKnex`. int8 values (bigint columns,
+counts) are returned as numbers, as with mysql2 and better-sqlite3, using a
+per-connection parser; see `usePostgresInt8Numbers`.
+
+```ts
+static createPostgresKnex(connection: string, database?: string): Knex {
+    const c: Knex.PgConnectionConfig = JSON.parse(connection);
+    if (database) {
+        c.database = database;
+    }
+    const config: Knex.Config = {
+        client: "pg",
+        connection: c,
+        pool: { min: 0, max: 7, idleTimeoutMillis: 15000 }
+    };
+    const knex = makeKnex(config);
+    usePostgresInt8Numbers(knex);
+    return knex;
+}
+```
+See also: [usePostgresInt8Numbers](./storage.md#function-usepostgresint8numbers)
+
+Argument Details
+
++ **connection**
+  + JSON node-postgres connection config
++ **database**
+  + optional database name overriding `connection.database`
 
 ###### Method createStorageKnex