Skip to content

Commit

Permalink
docs: update READMEs of transactional plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
Papooch committed Jan 26, 2024
1 parent 0bd2292 commit 1c3790f
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Knex adapter for the `@nestjs-cls/transactional` plugin.

### ➡️ [Go to the documentation website](https://papooch.github.io/nestjs-cls/plugins/available-plugins/transactional) 📖
### ➡️ [Go to the documentation website](https://papooch.github.io/nestjs-cls/plugins/available-plugins/transactional/knex-adapter) 📖
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Prisma adapter for the `@nestjs-cls/transactional` plugin.

### ➡️ [Go to the documentation website](https://papooch.github.io/nestjs-cls/plugins/available-plugins/transactional) 📖
### ➡️ [Go to the documentation website](https://papooch.github.io/nestjs-cls/plugins/available-plugins/transactional/prisma-adapter) 📖
8 changes: 6 additions & 2 deletions packages/transactional/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# @nestjs-cls/transactional

Transactional plugin for the `nestjs-cls`
A "Transactional" plugin for nestjs-cls that provides a generic interface that can be used to wrap any function call in a CLS-enabled transaction by storing the transaction reference in the CLS context.

### ➡️ [Go to the documentation website](https://papooch.github.io/nestjs-cls/plugins) 📖
The transaction reference can be then retrieved in any other service and refer to the same transaction without having to pass it around.

The plugin is designed to be database-agnostic and can be used with any database library that supports transactions (via adapters). At the expense of using a minimal wrapper, it deliberately does not require any monkey-patching of the underlying library.

### ➡️ [Go to the documentation website](https://papooch.github.io/nestjs-cls/plugins/available-plugins/transactional) 📖

0 comments on commit 1c3790f

Please sign in to comment.