|
2 | 2 |
|
3 | 3 | [](https://github.com/asheswook/tranjs/actions/workflows/test.yml)
|
4 | 4 |
|
5 |
| -**Node.js Transaction Management Framework** |
| 5 | +TranJS is a transaction management framework which provides declaretive transaction, without any ORMs. |
6 | 6 |
|
7 |
| -TranJS is a transaction management framework for Node.js, inspired by Java Hibernate's `@Transactional` annotation. |
8 | 7 | It is designed to provide reliable and intuitive transaction management for mission-critical safety applications and general-purpose applications.
|
9 | 8 |
|
10 |
| -**This framework is now experimental and under development. Please feel free to contribute or provide feedback.** |
11 |
| - |
12 | 9 | ## Features
|
13 |
| -- ✅ **Effortless Declarative Transactions** |
| 10 | +- ✅ **Declarative Transaction via Decorator** |
14 | 11 | - ⚡ **TypeScript Native**
|
15 | 12 | - 🛠️ **No Dependencies, Lightweight (15KB)**
|
16 | 13 | - 🔄 **Flexible Transaction Propagation**
|
17 | 14 |
|
18 | 15 | ## Getting Started
|
19 | 16 | * API Documentation is available at [here](/docs/api.md).
|
20 |
| -* The [example](/examples) contains a simple example of how to use the TranJS framework. |
21 | 17 | * Supported drivers are available at [here](/docs/drivers.md).
|
22 |
| - |
23 |
| -If you have any questions or need help, just ask! |
24 |
| - |
25 |
| -## Installation |
26 |
| - |
27 |
| -It should be set up for the database you want to use. See [here](/docs/drivers.md). |
28 |
| - |
29 |
| -Also, you can refer to the [self-implementation](/docs/self-implement-guide.md) guide if you want to implement the driver yourself. |
| 18 | +* The [example](/examples) contains a simple example of how to use the TranJS framework. |
30 | 19 |
|
31 | 20 | ## Usage
|
32 | 21 |
|
@@ -59,10 +48,12 @@ Execute Query Chansu 100
|
59 | 48 | Commit Transaction (id: ae8wml5i78rt) # Transaction committed when transfer() finished
|
60 | 49 | ```
|
61 | 50 |
|
62 |
| -## The reason why made this |
63 |
| -While developing software requiring robust transaction management, I needed a way to group multiple query executions into a single transaction. Initially, I used anonymous functions, referred to as _Executables_, to achieve this. However, this approach was complex, required extra boilerplate code, and made it difficult for new developers to understand. |
| 51 | +## Installation |
| 52 | + |
| 53 | +It should be set up for the database you want to use. See [here](/docs/drivers.md). |
64 | 54 |
|
65 |
| -To simplify this process, I created **tranjs**, a framework that enables transaction management in Node.js using a clean and intuitive `@Transactional` decorator, inspired by Java Hibernate. |
| 55 | +> [!NOTE] |
| 56 | +> If the driver you want to use does not exist, [you can implement it on your own.](/docs/self-implement-guide.md) |
66 | 57 |
|
67 | 58 | ## LICENSE
|
68 | 59 |
|
|
0 commit comments