arvo-core 1.1.13 → 1.1.14
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +10 -0
- package/dist/ArvoEventFactory/index.d.ts +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
@@ -24,6 +24,16 @@ Key features of Arvo include:
|
|
24
24
|
|
25
25
|
Whether you're building a small microservice or a large-scale distributed system, my hope with Arvo is to offers you some of the tools and patterns to help you succeed in the world of event-driven architecture.
|
26
26
|
|
27
|
+
## Arvo suite
|
28
|
+
|
29
|
+
Arvo is a collection of libraries which allows you to build the event driven system in the Arvo pattern. However, if you feel you don't have to use them or you can use them as you see fit.
|
30
|
+
|
31
|
+
| Scope | NPM | Github | Documentation |
|
32
|
+
| ------------ | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
33
|
+
| Orchestration | https://www.npmjs.com/package/arvo-xstate?activeTab=readme | https://github.com/SaadAhmad123/arvo-xstate | https://saadahmad123.github.io/arvo-xstate/index.html |
|
34
|
+
| Core | https://www.npmjs.com/package/arvo-core?activeTab=readme | https://github.com/SaadAhmad123/arvo-core | https://saadahmad123.github.io/arvo-core/index.html |
|
35
|
+
| Event Handling | https://www.npmjs.com/package/arvo-event-handler?activeTab=readme | https://github.com/SaadAhmad123/arvo-event-handler | https://saadahmad123.github.io/arvo-event-handler/index.html |
|
36
|
+
|
27
37
|
# Arvo - Core
|
28
38
|
|
29
39
|
This core package defines primitive types and utility functions to help you quickly start building interesting and robust event-driven applications.
|
@@ -26,7 +26,7 @@ export default class ArvoEventFactory<TUri extends string = string, TType extend
|
|
26
26
|
* @returns The created ArvoEvent as per the accept record of the contract.
|
27
27
|
* @throws If the event data fails validation against the contract.
|
28
28
|
*/
|
29
|
-
accepts<TExtension extends Record<string, any>>(event: Omit<CreateArvoEvent<z.
|
29
|
+
accepts<TExtension extends Record<string, any>>(event: Omit<CreateArvoEvent<z.input<TAcceptSchema>, TType>, 'type' | 'datacontenttype' | 'dataschema'>, extensions?: TExtension): import("..").ArvoEvent<z.TypeOf<TAcceptSchema>, TExtension, TType>;
|
30
30
|
/**
|
31
31
|
* Creates an ArvoEvent as per one of the emits record in the contract.
|
32
32
|
*
|
@@ -37,7 +37,7 @@ export default class ArvoEventFactory<TUri extends string = string, TType extend
|
|
37
37
|
* @returns The created ArvoEvent as per one of the emits records of the contract.
|
38
38
|
* @throws If the event data fails validation against the contract.
|
39
39
|
*/
|
40
|
-
emits<U extends keyof TEmits & string, TExtension extends Record<string, any>>(event: Omit<CreateArvoEvent<z.
|
40
|
+
emits<U extends keyof TEmits & string, TExtension extends Record<string, any>>(event: Omit<CreateArvoEvent<z.input<TEmits[U]>, U>, 'datacontenttype' | 'dataschema'>, extensions?: TExtension): import("..").ArvoEvent<z.TypeOf<TEmits[U]>, TExtension, U>;
|
41
41
|
/**
|
42
42
|
* Creates a system error ArvoEvent.
|
43
43
|
*
|