Skip to content

Commit 8143d24

Browse files
xziyxziy
committed
docs: list AwaitEmitter events
1 parent 930ebf5 commit 8143d24

File tree

1 file changed

+86
-0
lines changed

1 file changed

+86
-0
lines changed

‎docs/AwaitEmitterEvents.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# AwaitEmitter Events
2+
3+
This document summarizes all events exposed by `AwaitEmitter`. Each event name corresponds to a specific hook in the core logic. Use `emitter.on(eventName, id, handler)` to subscribe to events. All parameters in the list below follow the typings from `libs/AwaitEmitter.ts`.
4+
5+
## Usage Example
6+
7+
```ts
8+
import emitter from './AwaitEmitter';
9+
10+
emitter.on("core:order-after-create", "my-listener", async (order) => {
11+
// your code here
12+
});
13+
```
14+
15+
## Event Reference
16+
17+
| Event Name | Argument Types |
18+
|------------|---------------|
19+
| `rms-sync:before-each-group-item` | `[GroupRecord]` |
20+
| `rms-sync:before-each-product-item` | `[DishRecord]` |
21+
| `rms-sync:after-sync-products` | `[]` |
22+
| `rms-sync:out-of-stocks-before-each-product-item` | `[Pick<DishRecord, "balance" | "rmsId">]` |
23+
| `core:product-before-create` | `[DishRecord]` |
24+
| `core:payment-document-check` | `[PaymentDocumentRecord]` |
25+
| `core:payment-document-paid` | `[PaymentDocumentRecord]` |
26+
| `core:payment-document-checked-document` | `[PaymentDocumentRecord]` |
27+
| `core:order-after-order` | `[OrderRecord]` |
28+
| `core:order-order-delivery` | `[OrderRecord]` |
29+
| `core:order-before-order` | `[OrderRecord]` |
30+
| `core:order-order` | `[OrderRecord]` |
31+
| `core:order-order-self-service` | `[OrderRecord]` |
32+
| `core:order-is-self-service` | `[OrderRecord, Customer, boolean, Address]` |
33+
| `core:order-check` | `[OrderRecord, Customer, boolean, Address, string]` |
34+
| `core:order-after-check-counting` | `[OrderRecord]` |
35+
| `core:order-before-check` | `[OrderRecord, Customer, boolean, Address]` |
36+
| `core:order-check-delivery` | `[OrderRecord]` |
37+
| `settings:${string}` | `[SettingsRecord]` |
38+
| `core:user-after-create` | `[UserRecord]` |
39+
| `core:payment-document-before-create` | `[Payment]` |
40+
| `core:order-after-dopaid` | `[OrderRecord]` |
41+
| `core:order-after-count` | `[OrderRecord]` |
42+
| `core:count-after-delivery-cost` | `[OrderRecord]` |
43+
| `core:order-after-check-delivery` | `[OrderRecord]` |
44+
| `core:count-before-delivery-cost` | `[OrderRecord]` |
45+
| `core:order-after-promotion` | `[OrderRecord]` |
46+
| `core:order-after-done` | `[OrderRecord, UserRecord, {isNewUser: boolean}]` |
47+
| `core:count-before-promotion` | `[OrderRecord]` |
48+
| `core:orderproduct-change-amount` | `[OrderDishRecord]` |
49+
| `core:order-return-full-order-destroy-orderdish` | `[DishRecord, OrderRecord]` |
50+
| `core:order-before-count` | `[OrderRecord]` |
51+
| `core:order-payment` | `[OrderRecord, PaymentBack]` |
52+
| `core:order-init-checkout` | `[OrderRecord, InitCheckout]` |
53+
| `core:maintenance-enabled` | `[MaintenanceRecord]` |
54+
| `core:maintenance-disabled` | `[]` |
55+
| `core:group-get-menu` | `[GroupRecord[], string]` |
56+
| `core:group-get-groups` | `[GetGroupType, { [groupId: string]: string }]` |
57+
| `core:group-after-create` | `[GroupRecord]` |
58+
| `core:group-before-update` | `[GroupRecord]` |
59+
| `core:group-after-update` | `[GroupRecord]` |
60+
| `core:group-before-create` | `[GroupRecord]` |
61+
| `core:product-after-create` | `[DishRecord]` |
62+
| `core:product-after-update` | `[DishRecord]` |
63+
| `core:product-before-update` | `[DishRecord]` |
64+
| `core:product-get-dishes` | `[DishRecord[]]` |
65+
| `dialog-box:new` | `[DialogBox]` |
66+
| `dialog-box:answer-received` | `[string, string]` |
67+
| `core:add-product-before-write` | `[OrderRecord, DishRecord]` |
68+
| `promotion-process:debug` | `[number, OrderRecord, PromotionRecord, any]` |
69+
| `core:adapter-rms-sync-out-of-stock-touch` | `[]` |
70+
| `core:order-after-create` | `[OrderRecord]` |
71+
| `core:order-before-add-dish` | `[CriteriaQuery<OrderRecord>, DishRecord | string, number, OrderModifier[], string, "user" | "promotion" | "core" | "custom", boolean | undefined, number | undefined]` |
72+
| `core:order-add-dish-reject-amount` | `[CriteriaQuery<OrderRecord>, DishRecord | string, number, OrderModifier[], string, "user" | "promotion" | "core" | "custom", boolean | undefined, number | undefined]` |
73+
| `core:order-after-add-dish` | `[OrderDishRecord, CriteriaQuery<OrderRecord>, DishRecord | string, number, OrderModifier[], string, "user" | "promotion" | "core" | "custom", boolean | undefined, number | undefined]` |
74+
| `core:order-before-remove-dish` | `[CriteriaQuery<OrderRecord>, OrderDishRecord, number, boolean | undefined]` |
75+
| `core:order-remove-dish-reject-no-orderdish` | `[CriteriaQuery<OrderRecord>, OrderDishRecord, number, boolean | undefined]` |
76+
| `core:order-before-set-count` | `[CriteriaQuery<OrderRecord>, OrderDishRecord, number]` |
77+
| `core:order-set-count-reject-amount` | `[CriteriaQuery<OrderRecord>, OrderDishRecord, number]` |
78+
| `core:order-after-set-count` | `[OrderRecord, CriteriaQuery<OrderRecord>, OrderDishRecord, number]` |
79+
| `core:order-set-count-reject-no-orderdish` | `[CriteriaQuery<OrderRecord>, OrderDishRecord, number]` |
80+
| `core:order-before-set-comment` | `[CriteriaQuery<OrderRecord>, OrderDishRecord, string]` |
81+
| `core:order-after-set-comment` | `[CriteriaQuery<OrderRecord>, OrderDishRecord, string]` |
82+
| `core:order-set-comment-reject-no-orderdish` | `[CriteriaQuery<OrderRecord>, OrderDishRecord, string]` |
83+
| `core:order-was-cleared` | `[CriteriaQuery<OrderRecord>]` |
84+
| `core:order-set-tag` | `[CriteriaQuery<OrderRecord>, string]` |
85+
| `core:order-set-custom-data` | `[CriteriaQuery<OrderRecord>, object]` |
86+
| `core:order-after-remove-dish` | `[OrderRecord, string, DishRecord, number, boolean]` |

0 commit comments

Comments
 (0)