@ttoss/postgresdb - npm Package Compare versions

Comparing version 0.2.2 to 0.2.3

package.json

 {
   "name": "@ttoss/postgresdb",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "A library to handle PostgreSQL database connections and queries",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

@@ -12,2 +12,12 @@ # @ttoss/postgresdb
 
+### ESM only
+
+This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). Make sure to use it in an ESM environment.
+
+```json
+{
+  "type": "module"
+}
+```
+
 ## Usage
@@ -111,2 +121,69 @@
 
+### Using in a monorepo
+
+If you want to use in a monorepo by sharing the models between packages, you need to create some configurations to make it work.
+
+#### On the `postgresdb` package
+
+1. Create your `postgresdb` package following the steps above.
+
+1. Exports your main file in the `package.json` file:
+
+   ```json
+   {
+     "type": "module",
+     "exports": "./src/index.ts"
+   }
+   ```
+
+1. Create a new file called `src/index.ts` with the following content to exports the `models` you've created:
+
+   ```typescript
+   export * as models from './models';
+   ```
+
+   _We recommend to not export the `db` object in this file because you may want to use different configurations in different packages._
+
+#### On the other packages
+
+1. Install `@ttoss/postgresdb` package:
+
+   ```bash
+   pnpm add @ttoss/postgresdb
+   ```
+
+1. Add your `postgresdb` package as a dependency. In the case you're using PNPM, you can use the [workspace protocol](https://pnpm.io/workspaces#workspace-protocol-workspace):
+
+   ```json
+   {
+     "dependencies": {
+       "@yourproject/postgresdb": "workspace:^"
+     }
+   }
+   ```
+
+1. Include the `postgresdb` package in the `include` field of the `tsconfig.json` file:
+
+   ```json
+   {
+     "include": ["src", "../postgresdb/src"]
+   }
+   ```
+
+   _This way, you can import the models using the `@yourproject/postgresdb` package._
+
+1. Create a new file called `src/db.ts` with the following content:
+
+   ```typescript
+   import { initialize } from '@ttoss/postgresdb';
+   import { models } from '@yourproject/postgresdb';
+
+   export const db = initialize({
+     models,
+     // other configurations
+   });
+   ```
+
+1. Use the `db` object to interact with the database.
+
 ## API
@@ -113,0 +190,0 @@

No alert changes

Improved metrics

Total package byte prevSize

9393

25.16%

Number of lines in readme file

229

50.66%

No dependency changes