@wooksjs/event-core 0.2.16 → 0.2.18
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/dist/index.d.ts +33 -30
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -12,32 +12,35 @@ export declare function attachHook<V = unknown, T extends (object | Function) =
|
|
|
12
12
|
* @param data
|
|
13
13
|
* @returns set of hooks { getCtx, restoreCtx, clearCtx, hookStore, getStore, setStore }
|
|
14
14
|
*/
|
|
15
|
-
export declare function createEventContext<S
|
|
16
|
-
getCtx: () => S
|
|
17
|
-
restoreCtx: () =>
|
|
15
|
+
export declare function createEventContext<S = TEmpty, EventTypeToCreate = TEmpty>(data: S & TGenericContextStore<EventTypeToCreate>): {
|
|
16
|
+
getCtx: () => S & TGenericContextStore<EventTypeToCreate>;
|
|
17
|
+
restoreCtx: () => TGenericContextStore<TEmpty>;
|
|
18
18
|
clearCtx: () => null;
|
|
19
|
-
store: <K extends keyof S
|
|
20
|
-
value: S[K];
|
|
21
|
-
hook: <K2 extends keyof Required<S
|
|
22
|
-
value: Required<S
|
|
19
|
+
store: <K extends keyof S | keyof TGenericContextStore<EventTypeToCreate>>(key: K) => {
|
|
20
|
+
value: (S & TGenericContextStore<EventTypeToCreate>)[K];
|
|
21
|
+
hook: <K2 extends keyof Required<S & TGenericContextStore<EventTypeToCreate>>[K]>(key2: K2) => {
|
|
22
|
+
value: Required<S & TGenericContextStore<EventTypeToCreate>>[K][K2];
|
|
23
23
|
isDefined: boolean;
|
|
24
24
|
};
|
|
25
|
-
init: <K2_1 extends keyof Required<S
|
|
26
|
-
set: <K2_2 extends keyof Required<S
|
|
27
|
-
get: <K2_3 extends keyof Required<S
|
|
28
|
-
has: <K2_4 extends keyof Required<S
|
|
29
|
-
del: <K2_5 extends keyof Required<S
|
|
25
|
+
init: <K2_1 extends keyof Required<S & TGenericContextStore<EventTypeToCreate>>[K]>(key2: K2_1, getter: () => Required<Required<S & TGenericContextStore<EventTypeToCreate>>[K]>[K2_1]) => Required<Required<S & TGenericContextStore<EventTypeToCreate>>[K]>[K2_1];
|
|
26
|
+
set: <K2_2 extends keyof Required<S & TGenericContextStore<EventTypeToCreate>>[K]>(key2: K2_2, v: Required<(S & TGenericContextStore<EventTypeToCreate>)[K]>[K2_2]) => Required<(S & TGenericContextStore<EventTypeToCreate>)[K]>[K2_2];
|
|
27
|
+
get: <K2_3 extends keyof Required<S & TGenericContextStore<EventTypeToCreate>>[K]>(key2: K2_3) => Required<S & TGenericContextStore<EventTypeToCreate>>[K][K2_3];
|
|
28
|
+
has: <K2_4 extends keyof Required<S & TGenericContextStore<EventTypeToCreate>>[K]>(key2: K2_4) => boolean;
|
|
29
|
+
del: <K2_5 extends keyof Required<S & TGenericContextStore<EventTypeToCreate>>[K]>(key2: K2_5) => void;
|
|
30
30
|
entries: () => [string, unknown][];
|
|
31
31
|
clear: () => void;
|
|
32
32
|
};
|
|
33
|
-
getStore: <K_1 extends keyof S
|
|
34
|
-
setStore: <K_2 extends keyof S
|
|
33
|
+
getStore: <K_1 extends keyof S | keyof TGenericContextStore<EventTypeToCreate>>(key: K_1) => (S & TGenericContextStore<EventTypeToCreate>)[K_1];
|
|
34
|
+
setStore: <K_2 extends keyof S | keyof TGenericContextStore<EventTypeToCreate>>(key: K_2, v: (S & TGenericContextStore<EventTypeToCreate>)[K_2]) => void;
|
|
35
35
|
};
|
|
36
36
|
|
|
37
37
|
export declare class EventLogger extends ProstoLogger<TEventLoggerData> {
|
|
38
38
|
constructor(eventId: string, opts?: TEventOptions['eventLogger']);
|
|
39
39
|
}
|
|
40
40
|
|
|
41
|
+
export declare interface TEmpty {
|
|
42
|
+
}
|
|
43
|
+
|
|
41
44
|
export declare interface TEventLoggerData {
|
|
42
45
|
eventId: string;
|
|
43
46
|
}
|
|
@@ -48,8 +51,8 @@ export declare interface TEventOptions {
|
|
|
48
51
|
} & TProstoLoggerOptions<TEventLoggerData>;
|
|
49
52
|
}
|
|
50
53
|
|
|
51
|
-
export declare type TGenericContextStore<
|
|
52
|
-
event:
|
|
54
|
+
export declare type TGenericContextStore<CustomEventType = TEmpty> = {
|
|
55
|
+
event: CustomEventType & TGenericEvent;
|
|
53
56
|
options: TEventOptions;
|
|
54
57
|
routeParams?: Record<string, string | string[]>;
|
|
55
58
|
};
|
|
@@ -67,26 +70,26 @@ export declare interface TGenericEvent {
|
|
|
67
70
|
*
|
|
68
71
|
* @returns set of hooks { getCtx, restoreCtx, clearCtx, hookStore, getStore, setStore }
|
|
69
72
|
*/
|
|
70
|
-
export declare function useEventContext<S
|
|
71
|
-
getCtx: () => S
|
|
72
|
-
restoreCtx: () =>
|
|
73
|
+
export declare function useEventContext<S = TEmpty, EventType = TEmpty>(expectedTypes?: string | string[]): {
|
|
74
|
+
getCtx: () => S & TGenericContextStore<EventType>;
|
|
75
|
+
restoreCtx: () => TGenericContextStore<TEmpty>;
|
|
73
76
|
clearCtx: () => null;
|
|
74
|
-
store: <K extends keyof S
|
|
75
|
-
value: S[K];
|
|
76
|
-
hook: <K2 extends keyof Required<S
|
|
77
|
-
value: Required<S
|
|
77
|
+
store: <K extends keyof S | keyof TGenericContextStore<EventType>>(key: K) => {
|
|
78
|
+
value: (S & TGenericContextStore<EventType>)[K];
|
|
79
|
+
hook: <K2 extends keyof Required<S & TGenericContextStore<EventType>>[K]>(key2: K2) => {
|
|
80
|
+
value: Required<S & TGenericContextStore<EventType>>[K][K2];
|
|
78
81
|
isDefined: boolean;
|
|
79
82
|
};
|
|
80
|
-
init: <K2_1 extends keyof Required<S
|
|
81
|
-
set: <K2_2 extends keyof Required<S
|
|
82
|
-
get: <K2_3 extends keyof Required<S
|
|
83
|
-
has: <K2_4 extends keyof Required<S
|
|
84
|
-
del: <K2_5 extends keyof Required<S
|
|
83
|
+
init: <K2_1 extends keyof Required<S & TGenericContextStore<EventType>>[K]>(key2: K2_1, getter: () => Required<Required<S & TGenericContextStore<EventType>>[K]>[K2_1]) => Required<Required<S & TGenericContextStore<EventType>>[K]>[K2_1];
|
|
84
|
+
set: <K2_2 extends keyof Required<S & TGenericContextStore<EventType>>[K]>(key2: K2_2, v: Required<(S & TGenericContextStore<EventType>)[K]>[K2_2]) => Required<(S & TGenericContextStore<EventType>)[K]>[K2_2];
|
|
85
|
+
get: <K2_3 extends keyof Required<S & TGenericContextStore<EventType>>[K]>(key2: K2_3) => Required<S & TGenericContextStore<EventType>>[K][K2_3];
|
|
86
|
+
has: <K2_4 extends keyof Required<S & TGenericContextStore<EventType>>[K]>(key2: K2_4) => boolean;
|
|
87
|
+
del: <K2_5 extends keyof Required<S & TGenericContextStore<EventType>>[K]>(key2: K2_5) => void;
|
|
85
88
|
entries: () => [string, unknown][];
|
|
86
89
|
clear: () => void;
|
|
87
90
|
};
|
|
88
|
-
getStore: <K_1 extends keyof S
|
|
89
|
-
setStore: <K_2 extends keyof S
|
|
91
|
+
getStore: <K_1 extends keyof S | keyof TGenericContextStore<EventType>>(key: K_1) => (S & TGenericContextStore<EventType>)[K_1];
|
|
92
|
+
setStore: <K_2 extends keyof S | keyof TGenericContextStore<EventType>>(key: K_2, v: (S & TGenericContextStore<EventType>)[K_2]) => void;
|
|
90
93
|
};
|
|
91
94
|
|
|
92
95
|
export declare function useEventId(): {
|