@niledatabase/server 2.1.1 → 2.1.2-alpha.0

package/README.md

@@ -36,7 +36,7 @@ await nile.api.createTenant({ name: 'name' });
 await nile.db.query('select * from todo');
 ```
 
-## Autoconfiguration
+## Auto-configuration
 
 In addition to `user` and `password`, a fully configured SDK must also have values for `db.host`, `databaseName`, and `databaseId`. If the values are not provided in either the `.env` file or the instance configuration, the SDK will automatically phone home to configure itself. For production, it is recommended to set those values.
 
@@ -53,6 +53,7 @@ Configuration passed to `Server` takes precedence over `.env` vars.
 | tenantId      | `string`     | NILEDB_TENANT   | ID of the tenant associated.                                             |
 | userId        | `string`     |                 | ID of the user associated.                                               |
 | db            | `PoolConfig` |                 | Configuration object for [pg.Pool](https://node-postgres.com/apis/pool). |
+| db.host       | `string`     | NILEDB_HOST     | Base host for DB. Defaut is `db.thenile.dev`                             |
 | api           | `object`     |                 | Configuration object for API settings.                                   |
 | api.basePath  | `string`     | NILEDB_API      | Base host for API for a specific region. Default is `api.thenile.dev`.   |
 | api.cookieKey | `string`     |                 | Key for API cookie. Default is `token`.                                  |

package/dist/Server.d.ts

@@ -1,5 +1,5 @@
 import { Pool } from 'pg';
-import { InstanceConfig, ServerConfig } from './types';
+import { ServerConfig } from './types';
 import { Config } from './utils/Config';
 import Auth from './auth';
 import Users from './users';
@@ -29,7 +29,7 @@ declare class Server {
      * returns the global Server object, an existing server that's already been configured,
      * or a new one if the config isn't in the cache
      */
-    getInstance(config: InstanceConfig): Server;
+    getInstance(config: ServerConfig): Server;
 }
 export default function Nile(config?: ServerConfig): Server;
 export {};