balebaazoo 1.2.0 → 1.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,9 +1,3 @@
|
|
|
1
|
-
<div dir="rtl" lang="fa">
|
|
2
|
-
|
|
3
|
-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/vazirmatn@33.0.3/Vazirmatn-font-face.css">
|
|
4
|
-
|
|
5
|
-
<div style="font-family: Vazirmatn, Tahoma, sans-serif;">
|
|
6
|
-
|
|
7
1
|
# balebaazoo
|
|
8
2
|
|
|
9
3
|
SDK مدرن و type-safe برای توسعهٔ بازو (Bot) در پیامرسان بله.
|
|
@@ -12,21 +6,22 @@ SDK مدرن و type-safe برای توسعهٔ بازو (Bot) در پیام
|
|
|
12
6
|
|
|
13
7
|
بر پایهٔ [مستندات رسمی API بازوی بله](https://docs.bale.ai/) ساخته شده است.
|
|
14
8
|
|
|
15
|
-
**English:** [README.en.md](README.en.md)
|
|
16
|
-
|
|
17
|
-
## مستندات فارسی
|
|
18
|
-
|
|
19
|
-
- **[راهنمای کامل استفاده](docs/fa/usage.md)**
|
|
20
|
-
- **[راهنمای انتشار npm](docs/fa/publishing.md)**
|
|
9
|
+
**English:** [README.en.md](README.en.md) · **مستندات فارسی:** [docs/fa/usage.md](docs/fa/usage.md)
|
|
21
10
|
|
|
22
11
|
## نصب
|
|
23
12
|
|
|
13
|
+
<div dir="ltr">
|
|
14
|
+
|
|
24
15
|
```bash
|
|
25
16
|
npm install balebaazoo
|
|
26
17
|
```
|
|
27
18
|
|
|
19
|
+
</div>
|
|
20
|
+
|
|
28
21
|
## شروع سریع
|
|
29
22
|
|
|
23
|
+
<div dir="ltr">
|
|
24
|
+
|
|
30
25
|
```typescript
|
|
31
26
|
import { Bot, InlineKeyboard, setupGracefulShutdown } from "balebaazoo";
|
|
32
27
|
|
|
@@ -51,18 +46,26 @@ void bot.start({
|
|
|
51
46
|
});
|
|
52
47
|
```
|
|
53
48
|
|
|
49
|
+
</div>
|
|
50
|
+
|
|
54
51
|
> **نکته:** `bot.start()` تا زمان `bot.stop()` ادامه دارد. برای لاگ بعد از راهاندازی از `onStart` استفاده کنید، نه `await` بعد از `start()`.
|
|
55
52
|
|
|
56
53
|
## TypeScript
|
|
57
54
|
|
|
58
55
|
پروژهٔ شما باید ESM باشد:
|
|
59
56
|
|
|
57
|
+
<div dir="ltr">
|
|
58
|
+
|
|
60
59
|
```json
|
|
61
60
|
{
|
|
62
61
|
"type": "module"
|
|
63
62
|
}
|
|
64
63
|
```
|
|
65
64
|
|
|
65
|
+
</div>
|
|
66
|
+
|
|
67
|
+
<div dir="ltr">
|
|
68
|
+
|
|
66
69
|
```json
|
|
67
70
|
{
|
|
68
71
|
"compilerOptions": {
|
|
@@ -74,6 +77,8 @@ void bot.start({
|
|
|
74
77
|
}
|
|
75
78
|
```
|
|
76
79
|
|
|
80
|
+
</div>
|
|
81
|
+
|
|
77
82
|
قالب آماده: [`templates/starter`](templates/starter)
|
|
78
83
|
|
|
79
84
|
### خطای TS1295
|
|
@@ -84,12 +89,18 @@ void bot.start({
|
|
|
84
89
|
|
|
85
90
|
نسخهٔ `1.0.1+` اجازه میدهد handler مستقیماً `ctx.reply()` را return کند:
|
|
86
91
|
|
|
92
|
+
<div dir="ltr">
|
|
93
|
+
|
|
87
94
|
```typescript
|
|
88
95
|
bot.command("start", (ctx) => ctx.reply("سلام!"));
|
|
89
96
|
```
|
|
90
97
|
|
|
98
|
+
</div>
|
|
99
|
+
|
|
91
100
|
### nodemon + TypeScript
|
|
92
101
|
|
|
102
|
+
<div dir="ltr">
|
|
103
|
+
|
|
93
104
|
```json
|
|
94
105
|
{
|
|
95
106
|
"watch": ["src"],
|
|
@@ -98,6 +109,8 @@ bot.command("start", (ctx) => ctx.reply("سلام!"));
|
|
|
98
109
|
}
|
|
99
110
|
```
|
|
100
111
|
|
|
112
|
+
</div>
|
|
113
|
+
|
|
101
114
|
## ویژگیها
|
|
102
115
|
|
|
103
116
|
- **Type-safe** — تایپهای کامل TypeScript
|
|
@@ -116,15 +129,16 @@ bot.command("start", (ctx) => ctx.reply("سلام!"));
|
|
|
116
129
|
|
|
117
130
|
## توسعه
|
|
118
131
|
|
|
132
|
+
<div dir="ltr">
|
|
133
|
+
|
|
119
134
|
```bash
|
|
120
135
|
npm install
|
|
121
136
|
npm run build
|
|
122
137
|
npm test
|
|
123
138
|
```
|
|
124
139
|
|
|
140
|
+
</div>
|
|
141
|
+
|
|
125
142
|
## لایسنس
|
|
126
143
|
|
|
127
144
|
GPL-3.0-or-later
|
|
128
|
-
|
|
129
|
-
</div>
|
|
130
|
-
</div>
|