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